This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

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

Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory. 

**Note**  
If you're using IAM Identity Center authentication, a user in IAM Identity Center, or a group in IAM Identity Center containing that user, must be assigned to the Amazon SageMaker Studio application from the IAM Identity Center Console to create a user profile. For more information about application assignment, see [Assign user access](https://docs.aws.amazon.com/singlesignon/latest/userguide/assignuserstoapp.html). After assignment is complete, a user profile can be created for that user in IAM Identity Center with AWS CloudFormation. 

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

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

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

```
{
  "Type" : "AWS::SageMaker::UserProfile",
  "Properties" : {
      "[DomainId](#cfn-sagemaker-userprofile-domainid)" : String,
      "[SingleSignOnUserIdentifier](#cfn-sagemaker-userprofile-singlesignonuseridentifier)" : String,
      "[SingleSignOnUserValue](#cfn-sagemaker-userprofile-singlesignonuservalue)" : String,
      "[Tags](#cfn-sagemaker-userprofile-tags)" : [ Tag, ... ],
      "[UserProfileName](#cfn-sagemaker-userprofile-userprofilename)" : String,
      "[UserSettings](#cfn-sagemaker-userprofile-usersettings)" : UserSettings
    }
}
```

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

```
Type: AWS::SageMaker::UserProfile
Properties:
  [DomainId](#cfn-sagemaker-userprofile-domainid): String
  [SingleSignOnUserIdentifier](#cfn-sagemaker-userprofile-singlesignonuseridentifier): String
  [SingleSignOnUserValue](#cfn-sagemaker-userprofile-singlesignonuservalue): String
  [Tags](#cfn-sagemaker-userprofile-tags): 
    - Tag
  [UserProfileName](#cfn-sagemaker-userprofile-userprofilename): String
  [UserSettings](#cfn-sagemaker-userprofile-usersettings): 
    UserSettings
```

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

`DomainId`  <a name="cfn-sagemaker-userprofile-domainid"></a>
The domain ID.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SingleSignOnUserIdentifier`  <a name="cfn-sagemaker-userprofile-singlesignonuseridentifier"></a>
A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.  
*Required*: No  
*Type*: String  
*Pattern*: `UserName`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SingleSignOnUserValue`  <a name="cfn-sagemaker-userprofile-singlesignonuservalue"></a>
The username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-sagemaker-userprofile-tags"></a>
An array of key-value pairs to apply to this resource.  
Tags that you specify for the User Profile are also added to all apps that the User Profile launches.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Required*: No  
*Type*: Array of [Tag](aws-properties-sagemaker-userprofile-tag.md)  
*Minimum*: `0`  
*Maximum*: `50`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`UserProfileName`  <a name="cfn-sagemaker-userprofile-userprofilename"></a>
The user profile name.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`UserSettings`  <a name="cfn-sagemaker-userprofile-usersettings"></a>
A collection of settings that apply to users of Amazon SageMaker Studio.  
*Required*: No  
*Type*: [UserSettings](aws-properties-sagemaker-userprofile-usersettings.md)  
*Minimum*: `0`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-sagemaker-userprofile-return-values"></a>

### Ref
<a name="aws-resource-sagemaker-userprofile-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Domain ID and the user profile name, such as `d-xxxxxxxxxxxx` and `my-user-profile`, respectively.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-sagemaker-userprofile-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-sagemaker-userprofile-return-values-fn--getatt-fn--getatt"></a>

`UserProfileArn`  <a name="UserProfileArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the user profile, such as `arn:aws:sagemaker:region:account-id:user-profile/domain-id/user-profile-name`.

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

Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications.

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

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

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

```
{
  "[IdleSettings](#cfn-sagemaker-userprofile-applifecyclemanagement-idlesettings)" : IdleSettings
}
```

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

```
  [IdleSettings](#cfn-sagemaker-userprofile-applifecyclemanagement-idlesettings): 
    IdleSettings
```

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

`IdleSettings`  <a name="cfn-sagemaker-userprofile-applifecyclemanagement-idlesettings"></a>
Settings related to idle shutdown of Studio applications.  
*Required*: No  
*Type*: [IdleSettings](aws-properties-sagemaker-userprofile-idlesettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

The Code Editor application settings.

For more information about Code Editor, see [Get started with Code Editor in Amazon SageMaker](https://docs.aws.amazon.com/sagemaker/latest/dg/code-editor.html).

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

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

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

```
{
  "[AppLifecycleManagement](#cfn-sagemaker-userprofile-codeeditorappsettings-applifecyclemanagement)" : AppLifecycleManagement,
  "[BuiltInLifecycleConfigArn](#cfn-sagemaker-userprofile-codeeditorappsettings-builtinlifecycleconfigarn)" : String,
  "[CustomImages](#cfn-sagemaker-userprofile-codeeditorappsettings-customimages)" : [ CustomImage, ... ],
  "[DefaultResourceSpec](#cfn-sagemaker-userprofile-codeeditorappsettings-defaultresourcespec)" : ResourceSpec,
  "[LifecycleConfigArns](#cfn-sagemaker-userprofile-codeeditorappsettings-lifecycleconfigarns)" : [ String, ... ]
}
```

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

```
  [AppLifecycleManagement](#cfn-sagemaker-userprofile-codeeditorappsettings-applifecyclemanagement): 
    AppLifecycleManagement
  [BuiltInLifecycleConfigArn](#cfn-sagemaker-userprofile-codeeditorappsettings-builtinlifecycleconfigarn): String
  [CustomImages](#cfn-sagemaker-userprofile-codeeditorappsettings-customimages): 
    - CustomImage
  [DefaultResourceSpec](#cfn-sagemaker-userprofile-codeeditorappsettings-defaultresourcespec): 
    ResourceSpec
  [LifecycleConfigArns](#cfn-sagemaker-userprofile-codeeditorappsettings-lifecycleconfigarns): 
    - String
```

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

`AppLifecycleManagement`  <a name="cfn-sagemaker-userprofile-codeeditorappsettings-applifecyclemanagement"></a>
Settings that are used to configure and manage the lifecycle of CodeEditor applications.  
*Required*: No  
*Type*: [AppLifecycleManagement](aws-properties-sagemaker-userprofile-applifecyclemanagement.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BuiltInLifecycleConfigArn`  <a name="cfn-sagemaker-userprofile-codeeditorappsettings-builtinlifecycleconfigarn"></a>
The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.  
*Required*: No  
*Type*: String  
*Pattern*: `^(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CustomImages`  <a name="cfn-sagemaker-userprofile-codeeditorappsettings-customimages"></a>
A list of custom SageMaker images that are configured to run as a Code Editor app.  
*Required*: No  
*Type*: Array of [CustomImage](aws-properties-sagemaker-userprofile-customimage.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DefaultResourceSpec`  <a name="cfn-sagemaker-userprofile-codeeditorappsettings-defaultresourcespec"></a>
The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the Code Editor app.  
*Required*: No  
*Type*: [ResourceSpec](aws-properties-sagemaker-userprofile-resourcespec.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LifecycleConfigArns`  <a name="cfn-sagemaker-userprofile-codeeditorappsettings-lifecycleconfigarns"></a>
The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `0`  
*Maximum*: `30`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.

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

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

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

```
{
  "[RepositoryUrl](#cfn-sagemaker-userprofile-coderepository-repositoryurl)" : String
}
```

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

```
  [RepositoryUrl](#cfn-sagemaker-userprofile-coderepository-repositoryurl): String
```

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

`RepositoryUrl`  <a name="cfn-sagemaker-userprofile-coderepository-repositoryurl"></a>
The URL of the Git repository.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^https://([.\-_a-zA-Z0-9]+/?){3,1016}$`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

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

The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

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

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

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

```
{
  "[EFSFileSystemConfig](#cfn-sagemaker-userprofile-customfilesystemconfig-efsfilesystemconfig)" : EFSFileSystemConfig,
  "[FSxLustreFileSystemConfig](#cfn-sagemaker-userprofile-customfilesystemconfig-fsxlustrefilesystemconfig)" : FSxLustreFileSystemConfig,
  "[S3FileSystemConfig](#cfn-sagemaker-userprofile-customfilesystemconfig-s3filesystemconfig)" : S3FileSystemConfig
}
```

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

```
  [EFSFileSystemConfig](#cfn-sagemaker-userprofile-customfilesystemconfig-efsfilesystemconfig): 
    EFSFileSystemConfig
  [FSxLustreFileSystemConfig](#cfn-sagemaker-userprofile-customfilesystemconfig-fsxlustrefilesystemconfig): 
    FSxLustreFileSystemConfig
  [S3FileSystemConfig](#cfn-sagemaker-userprofile-customfilesystemconfig-s3filesystemconfig): 
    S3FileSystemConfig
```

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

`EFSFileSystemConfig`  <a name="cfn-sagemaker-userprofile-customfilesystemconfig-efsfilesystemconfig"></a>
The settings for a custom Amazon EFS file system.  
*Required*: No  
*Type*: [EFSFileSystemConfig](aws-properties-sagemaker-userprofile-efsfilesystemconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FSxLustreFileSystemConfig`  <a name="cfn-sagemaker-userprofile-customfilesystemconfig-fsxlustrefilesystemconfig"></a>
The settings for a custom Amazon FSx for Lustre file system.  
*Required*: No  
*Type*: [FSxLustreFileSystemConfig](aws-properties-sagemaker-userprofile-fsxlustrefilesystemconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3FileSystemConfig`  <a name="cfn-sagemaker-userprofile-customfilesystemconfig-s3filesystemconfig"></a>
Configuration settings for a custom Amazon S3 file system.  
*Required*: No  
*Type*: [S3FileSystemConfig](aws-properties-sagemaker-userprofile-s3filesystemconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

A custom SageMaker AI image. For more information, see [Bring your own SageMaker AI image](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html).

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

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

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

```
{
  "[AppImageConfigName](#cfn-sagemaker-userprofile-customimage-appimageconfigname)" : String,
  "[ImageName](#cfn-sagemaker-userprofile-customimage-imagename)" : String,
  "[ImageVersionNumber](#cfn-sagemaker-userprofile-customimage-imageversionnumber)" : Integer
}
```

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

```
  [AppImageConfigName](#cfn-sagemaker-userprofile-customimage-appimageconfigname): String
  [ImageName](#cfn-sagemaker-userprofile-customimage-imagename): String
  [ImageVersionNumber](#cfn-sagemaker-userprofile-customimage-imageversionnumber): Integer
```

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

`AppImageConfigName`  <a name="cfn-sagemaker-userprofile-customimage-appimageconfigname"></a>
The name of the AppImageConfig.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}`  
*Maximum*: `63`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ImageName`  <a name="cfn-sagemaker-userprofile-customimage-imagename"></a>
The name of the CustomImage. Must be unique to your account.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$`  
*Maximum*: `63`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ImageVersionNumber`  <a name="cfn-sagemaker-userprofile-customimage-imageversionnumber"></a>
The version number of the CustomImage.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

Details about the POSIX identity that is used for file system operations.

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

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

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

```
{
  "[Gid](#cfn-sagemaker-userprofile-customposixuserconfig-gid)" : Integer,
  "[Uid](#cfn-sagemaker-userprofile-customposixuserconfig-uid)" : Integer
}
```

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

```
  [Gid](#cfn-sagemaker-userprofile-customposixuserconfig-gid): Integer
  [Uid](#cfn-sagemaker-userprofile-customposixuserconfig-uid): Integer
```

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

`Gid`  <a name="cfn-sagemaker-userprofile-customposixuserconfig-gid"></a>
The POSIX group ID.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `1001`  
*Maximum*: `4000000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Uid`  <a name="cfn-sagemaker-userprofile-customposixuserconfig-uid"></a>
The POSIX user ID.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `10000`  
*Maximum*: `4000000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

A collection of default EBS storage settings that apply to spaces created within a domain or user profile.

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

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

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

```
{
  "[DefaultEbsVolumeSizeInGb](#cfn-sagemaker-userprofile-defaultebsstoragesettings-defaultebsvolumesizeingb)" : Integer,
  "[MaximumEbsVolumeSizeInGb](#cfn-sagemaker-userprofile-defaultebsstoragesettings-maximumebsvolumesizeingb)" : Integer
}
```

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

```
  [DefaultEbsVolumeSizeInGb](#cfn-sagemaker-userprofile-defaultebsstoragesettings-defaultebsvolumesizeingb): Integer
  [MaximumEbsVolumeSizeInGb](#cfn-sagemaker-userprofile-defaultebsstoragesettings-maximumebsvolumesizeingb): Integer
```

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

`DefaultEbsVolumeSizeInGb`  <a name="cfn-sagemaker-userprofile-defaultebsstoragesettings-defaultebsvolumesizeingb"></a>
The default size of the EBS storage volume for a space.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `5`  
*Maximum*: `16384`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaximumEbsVolumeSizeInGb`  <a name="cfn-sagemaker-userprofile-defaultebsstoragesettings-maximumebsvolumesizeingb"></a>
The maximum size of the EBS storage volume for a space.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `5`  
*Maximum*: `16384`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

The default storage settings for a space.

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

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

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

```
{
  "[DefaultEbsStorageSettings](#cfn-sagemaker-userprofile-defaultspacestoragesettings-defaultebsstoragesettings)" : DefaultEbsStorageSettings
}
```

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

```
  [DefaultEbsStorageSettings](#cfn-sagemaker-userprofile-defaultspacestoragesettings-defaultebsstoragesettings): 
    DefaultEbsStorageSettings
```

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

`DefaultEbsStorageSettings`  <a name="cfn-sagemaker-userprofile-defaultspacestoragesettings-defaultebsstoragesettings"></a>
The default EBS storage settings for a space.  
*Required*: No  
*Type*: [DefaultEbsStorageSettings](aws-properties-sagemaker-userprofile-defaultebsstoragesettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

The settings for assigning a custom Amazon EFS file system to a user profile or space for an Amazon SageMaker AI Domain.

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

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

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

```
{
  "[FileSystemId](#cfn-sagemaker-userprofile-efsfilesystemconfig-filesystemid)" : String,
  "[FileSystemPath](#cfn-sagemaker-userprofile-efsfilesystemconfig-filesystempath)" : String
}
```

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

```
  [FileSystemId](#cfn-sagemaker-userprofile-efsfilesystemconfig-filesystemid): String
  [FileSystemPath](#cfn-sagemaker-userprofile-efsfilesystemconfig-filesystempath): String
```

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

`FileSystemId`  <a name="cfn-sagemaker-userprofile-efsfilesystemconfig-filesystemid"></a>
The ID of your Amazon EFS file system.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(fs-[0-9a-f]{8,})$`  
*Minimum*: `11`  
*Maximum*: `21`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FileSystemPath`  <a name="cfn-sagemaker-userprofile-efsfilesystemconfig-filesystempath"></a>
The path to the file system directory that is accessible in Amazon SageMaker AI Studio. Permitted users can access only this directory and below.  
*Required*: No  
*Type*: String  
*Pattern*: `^\/\S*$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an Amazon SageMaker Domain.

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

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

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

```
{
  "[FileSystemId](#cfn-sagemaker-userprofile-fsxlustrefilesystemconfig-filesystemid)" : String,
  "[FileSystemPath](#cfn-sagemaker-userprofile-fsxlustrefilesystemconfig-filesystempath)" : String
}
```

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

```
  [FileSystemId](#cfn-sagemaker-userprofile-fsxlustrefilesystemconfig-filesystemid): String
  [FileSystemPath](#cfn-sagemaker-userprofile-fsxlustrefilesystemconfig-filesystempath): String
```

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

`FileSystemId`  <a name="cfn-sagemaker-userprofile-fsxlustrefilesystemconfig-filesystemid"></a>
The globally unique, 17-digit, ID of the file system, assigned by Amazon FSx for Lustre.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(fs-[0-9a-f]{8,})$`  
*Minimum*: `11`  
*Maximum*: `21`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FileSystemPath`  <a name="cfn-sagemaker-userprofile-fsxlustrefilesystemconfig-filesystempath"></a>
The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.  
*Required*: No  
*Type*: String  
*Pattern*: `^\/\S*$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

The SageMaker images that are hidden from the Studio user interface. You must specify the SageMaker image name and version aliases.

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

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

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

```
{
  "[SageMakerImageName](#cfn-sagemaker-userprofile-hiddensagemakerimage-sagemakerimagename)" : String,
  "[VersionAliases](#cfn-sagemaker-userprofile-hiddensagemakerimage-versionaliases)" : [ String, ... ]
}
```

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

```
  [SageMakerImageName](#cfn-sagemaker-userprofile-hiddensagemakerimage-sagemakerimagename): String
  [VersionAliases](#cfn-sagemaker-userprofile-hiddensagemakerimage-versionaliases): 
    - String
```

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

`SageMakerImageName`  <a name="cfn-sagemaker-userprofile-hiddensagemakerimage-sagemakerimagename"></a>
 The SageMaker image name that you are hiding from the Studio user interface.   
*Required*: No  
*Type*: String  
*Allowed values*: `sagemaker_distribution`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VersionAliases`  <a name="cfn-sagemaker-userprofile-hiddensagemakerimage-versionaliases"></a>
 The version aliases you are hiding from the Studio user interface.   
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `128 | 20`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

Settings related to idle shutdown of Studio applications.

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

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

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

```
{
  "[IdleTimeoutInMinutes](#cfn-sagemaker-userprofile-idlesettings-idletimeoutinminutes)" : Integer,
  "[LifecycleManagement](#cfn-sagemaker-userprofile-idlesettings-lifecyclemanagement)" : String,
  "[MaxIdleTimeoutInMinutes](#cfn-sagemaker-userprofile-idlesettings-maxidletimeoutinminutes)" : Integer,
  "[MinIdleTimeoutInMinutes](#cfn-sagemaker-userprofile-idlesettings-minidletimeoutinminutes)" : Integer
}
```

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

```
  [IdleTimeoutInMinutes](#cfn-sagemaker-userprofile-idlesettings-idletimeoutinminutes): Integer
  [LifecycleManagement](#cfn-sagemaker-userprofile-idlesettings-lifecyclemanagement): String
  [MaxIdleTimeoutInMinutes](#cfn-sagemaker-userprofile-idlesettings-maxidletimeoutinminutes): Integer
  [MinIdleTimeoutInMinutes](#cfn-sagemaker-userprofile-idlesettings-minidletimeoutinminutes): Integer
```

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

`IdleTimeoutInMinutes`  <a name="cfn-sagemaker-userprofile-idlesettings-idletimeoutinminutes"></a>
The time that SageMaker waits after the application becomes idle before shutting it down.  
*Required*: No  
*Type*: Integer  
*Minimum*: `60`  
*Maximum*: `525600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LifecycleManagement`  <a name="cfn-sagemaker-userprofile-idlesettings-lifecyclemanagement"></a>
Indicates whether idle shutdown is activated for the application type.  
*Required*: No  
*Type*: String  
*Allowed values*: `ENABLED | DISABLED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaxIdleTimeoutInMinutes`  <a name="cfn-sagemaker-userprofile-idlesettings-maxidletimeoutinminutes"></a>
The maximum value in minutes that custom idle shutdown can be set to by the user.  
*Required*: No  
*Type*: Integer  
*Minimum*: `60`  
*Maximum*: `525600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MinIdleTimeoutInMinutes`  <a name="cfn-sagemaker-userprofile-idlesettings-minidletimeoutinminutes"></a>
The minimum value in minutes that custom idle shutdown can be set to by the user.  
*Required*: No  
*Type*: Integer  
*Minimum*: `60`  
*Maximum*: `525600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

The settings for the JupyterLab application.

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

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

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

```
{
  "[AppLifecycleManagement](#cfn-sagemaker-userprofile-jupyterlabappsettings-applifecyclemanagement)" : AppLifecycleManagement,
  "[BuiltInLifecycleConfigArn](#cfn-sagemaker-userprofile-jupyterlabappsettings-builtinlifecycleconfigarn)" : String,
  "[CodeRepositories](#cfn-sagemaker-userprofile-jupyterlabappsettings-coderepositories)" : [ CodeRepository, ... ],
  "[CustomImages](#cfn-sagemaker-userprofile-jupyterlabappsettings-customimages)" : [ CustomImage, ... ],
  "[DefaultResourceSpec](#cfn-sagemaker-userprofile-jupyterlabappsettings-defaultresourcespec)" : ResourceSpec,
  "[LifecycleConfigArns](#cfn-sagemaker-userprofile-jupyterlabappsettings-lifecycleconfigarns)" : [ String, ... ]
}
```

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

```
  [AppLifecycleManagement](#cfn-sagemaker-userprofile-jupyterlabappsettings-applifecyclemanagement): 
    AppLifecycleManagement
  [BuiltInLifecycleConfigArn](#cfn-sagemaker-userprofile-jupyterlabappsettings-builtinlifecycleconfigarn): String
  [CodeRepositories](#cfn-sagemaker-userprofile-jupyterlabappsettings-coderepositories): 
    - CodeRepository
  [CustomImages](#cfn-sagemaker-userprofile-jupyterlabappsettings-customimages): 
    - CustomImage
  [DefaultResourceSpec](#cfn-sagemaker-userprofile-jupyterlabappsettings-defaultresourcespec): 
    ResourceSpec
  [LifecycleConfigArns](#cfn-sagemaker-userprofile-jupyterlabappsettings-lifecycleconfigarns): 
    - String
```

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

`AppLifecycleManagement`  <a name="cfn-sagemaker-userprofile-jupyterlabappsettings-applifecyclemanagement"></a>
Indicates whether idle shutdown is activated for JupyterLab applications.  
*Required*: No  
*Type*: [AppLifecycleManagement](aws-properties-sagemaker-userprofile-applifecyclemanagement.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BuiltInLifecycleConfigArn`  <a name="cfn-sagemaker-userprofile-jupyterlabappsettings-builtinlifecycleconfigarn"></a>
The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.  
*Required*: No  
*Type*: String  
*Pattern*: `^(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CodeRepositories`  <a name="cfn-sagemaker-userprofile-jupyterlabappsettings-coderepositories"></a>
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.  
*Required*: No  
*Type*: Array of [CodeRepository](aws-properties-sagemaker-userprofile-coderepository.md)  
*Minimum*: `0`  
*Maximum*: `30`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CustomImages`  <a name="cfn-sagemaker-userprofile-jupyterlabappsettings-customimages"></a>
A list of custom SageMaker images that are configured to run as a JupyterLab app.  
*Required*: No  
*Type*: Array of [CustomImage](aws-properties-sagemaker-userprofile-customimage.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DefaultResourceSpec`  <a name="cfn-sagemaker-userprofile-jupyterlabappsettings-defaultresourcespec"></a>
The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app.  
*Required*: No  
*Type*: [ResourceSpec](aws-properties-sagemaker-userprofile-resourcespec.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LifecycleConfigArns`  <a name="cfn-sagemaker-userprofile-jupyterlabappsettings-lifecycleconfigarns"></a>
The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set `LifecycleConfigArns` to an empty list.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `0`  
*Maximum*: `30`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

The JupyterServer app settings.

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

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

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

```
{
  "[DefaultResourceSpec](#cfn-sagemaker-userprofile-jupyterserverappsettings-defaultresourcespec)" : ResourceSpec,
  "[LifecycleConfigArns](#cfn-sagemaker-userprofile-jupyterserverappsettings-lifecycleconfigarns)" : [ String, ... ]
}
```

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

```
  [DefaultResourceSpec](#cfn-sagemaker-userprofile-jupyterserverappsettings-defaultresourcespec): 
    ResourceSpec
  [LifecycleConfigArns](#cfn-sagemaker-userprofile-jupyterserverappsettings-lifecycleconfigarns): 
    - String
```

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

`DefaultResourceSpec`  <a name="cfn-sagemaker-userprofile-jupyterserverappsettings-defaultresourcespec"></a>
The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app.  
*Required*: No  
*Type*: [ResourceSpec](aws-properties-sagemaker-userprofile-resourcespec.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LifecycleConfigArns`  <a name="cfn-sagemaker-userprofile-jupyterserverappsettings-lifecycleconfigarns"></a>
 The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the `DefaultResourceSpec` parameter is also required.  
To remove a Lifecycle Config, you must set `LifecycleConfigArns` to an empty list.
*Required*: No  
*Type*: Array of String  
*Minimum*: `0`  
*Maximum*: `30`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

The KernelGateway app settings.

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

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

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

```
{
  "[CustomImages](#cfn-sagemaker-userprofile-kernelgatewayappsettings-customimages)" : [ CustomImage, ... ],
  "[DefaultResourceSpec](#cfn-sagemaker-userprofile-kernelgatewayappsettings-defaultresourcespec)" : ResourceSpec,
  "[LifecycleConfigArns](#cfn-sagemaker-userprofile-kernelgatewayappsettings-lifecycleconfigarns)" : [ String, ... ]
}
```

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

```
  [CustomImages](#cfn-sagemaker-userprofile-kernelgatewayappsettings-customimages): 
    - CustomImage
  [DefaultResourceSpec](#cfn-sagemaker-userprofile-kernelgatewayappsettings-defaultresourcespec): 
    ResourceSpec
  [LifecycleConfigArns](#cfn-sagemaker-userprofile-kernelgatewayappsettings-lifecycleconfigarns): 
    - String
```

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

`CustomImages`  <a name="cfn-sagemaker-userprofile-kernelgatewayappsettings-customimages"></a>
A list of custom SageMaker AI images that are configured to run as a KernelGateway app.  
The maximum number of custom images are as follows.  
+ On a domain level: 200
+ On a space level: 5
+ On a user profile level: 5
*Required*: No  
*Type*: Array of [CustomImage](aws-properties-sagemaker-userprofile-customimage.md)  
*Minimum*: `0`  
*Maximum*: `30`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DefaultResourceSpec`  <a name="cfn-sagemaker-userprofile-kernelgatewayappsettings-defaultresourcespec"></a>
The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the KernelGateway app.  
The Amazon SageMaker AI Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the AWS CLI or CloudFormation and the instance type parameter value is not passed.
*Required*: No  
*Type*: [ResourceSpec](aws-properties-sagemaker-userprofile-resourcespec.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LifecycleConfigArns`  <a name="cfn-sagemaker-userprofile-kernelgatewayappsettings-lifecycleconfigarns"></a>
 The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.  
To remove a Lifecycle Config, you must set `LifecycleConfigArns` to an empty list.
*Required*: No  
*Type*: Array of String  
*Minimum*: `0`  
*Maximum*: `30`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.

**Note**  
When both `SageMakerImageVersionArn` and `SageMakerImageArn` are passed, `SageMakerImageVersionArn` is used. Any updates to `SageMakerImageArn` will not take effect if `SageMakerImageVersionArn` already exists in the `ResourceSpec` because `SageMakerImageVersionArn` always takes precedence. To clear the value set for `SageMakerImageVersionArn`, pass `None` as the value.

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

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

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

```
{
  "[InstanceType](#cfn-sagemaker-userprofile-resourcespec-instancetype)" : String,
  "[LifecycleConfigArn](#cfn-sagemaker-userprofile-resourcespec-lifecycleconfigarn)" : String,
  "[SageMakerImageArn](#cfn-sagemaker-userprofile-resourcespec-sagemakerimagearn)" : String,
  "[SageMakerImageVersionArn](#cfn-sagemaker-userprofile-resourcespec-sagemakerimageversionarn)" : String
}
```

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

```
  [InstanceType](#cfn-sagemaker-userprofile-resourcespec-instancetype): String
  [LifecycleConfigArn](#cfn-sagemaker-userprofile-resourcespec-lifecycleconfigarn): String
  [SageMakerImageArn](#cfn-sagemaker-userprofile-resourcespec-sagemakerimagearn): String
  [SageMakerImageVersionArn](#cfn-sagemaker-userprofile-resourcespec-sagemakerimageversionarn): String
```

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

`InstanceType`  <a name="cfn-sagemaker-userprofile-resourcespec-instancetype"></a>
The instance type that the image version runs on.  
**JupyterServer apps** only support the `system` value.  
For **KernelGateway apps**, the `system` value is translated to `ml.t3.medium`. KernelGateway apps also support all other values for available instance types.
*Required*: No  
*Type*: String  
*Allowed values*: `system | ml.t3.micro | ml.t3.small | ml.t3.medium | ml.t3.large | ml.t3.xlarge | ml.t3.2xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.m5d.large | ml.m5d.xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.8xlarge | ml.m5d.12xlarge | ml.m5d.16xlarge | ml.m5d.24xlarge | ml.c5.large | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.p3dn.24xlarge | ml.g4dn.xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.r5.large | ml.r5.xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.8xlarge | ml.r5.12xlarge | ml.r5.16xlarge | ml.r5.24xlarge | ml.g5.xlarge | ml.g5.2xlarge | ml.g5.4xlarge | ml.g5.8xlarge | ml.g5.12xlarge | ml.g5.16xlarge | ml.g5.24xlarge | ml.g5.48xlarge | ml.g6.xlarge | ml.g6.2xlarge | ml.g6.4xlarge | ml.g6.8xlarge | ml.g6.12xlarge | ml.g6.16xlarge | ml.g6.24xlarge | ml.g6.48xlarge | ml.g6e.xlarge | ml.g6e.2xlarge | ml.g6e.4xlarge | ml.g6e.8xlarge | ml.g6e.12xlarge | ml.g6e.16xlarge | ml.g6e.24xlarge | ml.g6e.48xlarge | ml.geospatial.interactive | ml.p4d.24xlarge | ml.p4de.24xlarge | ml.trn1.2xlarge | ml.trn1.32xlarge | ml.trn1n.32xlarge | ml.p5.48xlarge | ml.p5e.48xlarge | ml.p5en.48xlarge | ml.m6i.large | ml.m6i.xlarge | ml.m6i.2xlarge | ml.m6i.4xlarge | ml.m6i.8xlarge | ml.m6i.12xlarge | ml.m6i.16xlarge | ml.m6i.24xlarge | ml.m6i.32xlarge | ml.m7i.large | ml.m7i.xlarge | ml.m7i.2xlarge | ml.m7i.4xlarge | ml.m7i.8xlarge | ml.m7i.12xlarge | ml.m7i.16xlarge | ml.m7i.24xlarge | ml.m7i.48xlarge | ml.c6i.large | ml.c6i.xlarge | ml.c6i.2xlarge | ml.c6i.4xlarge | ml.c6i.8xlarge | ml.c6i.12xlarge | ml.c6i.16xlarge | ml.c6i.24xlarge | ml.c6i.32xlarge | ml.c7i.large | ml.c7i.xlarge | ml.c7i.2xlarge | ml.c7i.4xlarge | ml.c7i.8xlarge | ml.c7i.12xlarge | ml.c7i.16xlarge | ml.c7i.24xlarge | ml.c7i.48xlarge | ml.r6i.large | ml.r6i.xlarge | ml.r6i.2xlarge | ml.r6i.4xlarge | ml.r6i.8xlarge | ml.r6i.12xlarge | ml.r6i.16xlarge | ml.r6i.24xlarge | ml.r6i.32xlarge | ml.r7i.large | ml.r7i.xlarge | ml.r7i.2xlarge | ml.r7i.4xlarge | ml.r7i.8xlarge | ml.r7i.12xlarge | ml.r7i.16xlarge | ml.r7i.24xlarge | ml.r7i.48xlarge | ml.m6id.large | ml.m6id.xlarge | ml.m6id.2xlarge | ml.m6id.4xlarge | ml.m6id.8xlarge | ml.m6id.12xlarge | ml.m6id.16xlarge | ml.m6id.24xlarge | ml.m6id.32xlarge | ml.c6id.large | ml.c6id.xlarge | ml.c6id.2xlarge | ml.c6id.4xlarge | ml.c6id.8xlarge | ml.c6id.12xlarge | ml.c6id.16xlarge | ml.c6id.24xlarge | ml.c6id.32xlarge | ml.r6id.large | ml.r6id.xlarge | ml.r6id.2xlarge | ml.r6id.4xlarge | ml.r6id.8xlarge | ml.r6id.12xlarge | ml.r6id.16xlarge | ml.r6id.24xlarge | ml.r6id.32xlarge`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LifecycleConfigArn`  <a name="cfn-sagemaker-userprofile-resourcespec-lifecycleconfigarn"></a>
 The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.  
*Required*: No  
*Type*: String  
*Pattern*: `^(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SageMakerImageArn`  <a name="cfn-sagemaker-userprofile-resourcespec-sagemakerimagearn"></a>
The ARN of the SageMaker AI image that the image version belongs to.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SageMakerImageVersionArn`  <a name="cfn-sagemaker-userprofile-resourcespec-sagemakerimageversionarn"></a>
The ARN of the image version created on the instance. To clear the value set for `SageMakerImageVersionArn`, pass `None` as the value.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

A collection of settings that configure user interaction with the `RStudioServerPro` app.

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

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

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

```
{
  "[AccessStatus](#cfn-sagemaker-userprofile-rstudioserverproappsettings-accessstatus)" : String,
  "[UserGroup](#cfn-sagemaker-userprofile-rstudioserverproappsettings-usergroup)" : String
}
```

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

```
  [AccessStatus](#cfn-sagemaker-userprofile-rstudioserverproappsettings-accessstatus): String
  [UserGroup](#cfn-sagemaker-userprofile-rstudioserverproappsettings-usergroup): String
```

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

`AccessStatus`  <a name="cfn-sagemaker-userprofile-rstudioserverproappsettings-accessstatus"></a>
Indicates whether the current user has access to the `RStudioServerPro` app.  
*Required*: No  
*Type*: String  
*Allowed values*: `ENABLED | DISABLED`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`UserGroup`  <a name="cfn-sagemaker-userprofile-rstudioserverproappsettings-usergroup"></a>
The level of permissions that the user has within the `RStudioServerPro` app. This value defaults to `User`. The `Admin` value allows the user access to the RStudio Administrative Dashboard.  
*Required*: No  
*Type*: String  
*Allowed values*: `R_STUDIO_ADMIN | R_STUDIO_USER`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

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

Configuration for the custom Amazon S3 file system.

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

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

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

```
{
  "[MountPath](#cfn-sagemaker-userprofile-s3filesystemconfig-mountpath)" : String,
  "[S3Uri](#cfn-sagemaker-userprofile-s3filesystemconfig-s3uri)" : String
}
```

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

```
  [MountPath](#cfn-sagemaker-userprofile-s3filesystemconfig-mountpath): String
  [S3Uri](#cfn-sagemaker-userprofile-s3filesystemconfig-s3uri): String
```

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

`MountPath`  <a name="cfn-sagemaker-userprofile-s3filesystemconfig-mountpath"></a>
The file system path where the Amazon S3 storage location will be mounted within the Amazon SageMaker Studio environment.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3Uri`  <a name="cfn-sagemaker-userprofile-s3filesystemconfig-s3uri"></a>
The Amazon S3 URI of the S3 file system configuration.  
*Required*: No  
*Type*: String  
*Pattern*: `(s3)://([^/]+)/?(.*)`  
*Minimum*: `0`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# 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.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html) API is called, and as part of `UserSettings` when the [CreateUserProfile](https://docs.aws.amazon.com/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 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.aws.amazon.com/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 AWS 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.aws.amazon.com/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.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.

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

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

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

```
{
  "[HiddenAppTypes](#cfn-sagemaker-userprofile-studiowebportalsettings-hiddenapptypes)" : [ String, ... ],
  "[HiddenInstanceTypes](#cfn-sagemaker-userprofile-studiowebportalsettings-hiddeninstancetypes)" : [ String, ... ],
  "[HiddenMlTools](#cfn-sagemaker-userprofile-studiowebportalsettings-hiddenmltools)" : [ String, ... ],
  "[HiddenSageMakerImageVersionAliases](#cfn-sagemaker-userprofile-studiowebportalsettings-hiddensagemakerimageversionaliases)" : [ HiddenSageMakerImage, ... ]
}
```

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

```
  [HiddenAppTypes](#cfn-sagemaker-userprofile-studiowebportalsettings-hiddenapptypes): 
    - String
  [HiddenInstanceTypes](#cfn-sagemaker-userprofile-studiowebportalsettings-hiddeninstancetypes): 
    - String
  [HiddenMlTools](#cfn-sagemaker-userprofile-studiowebportalsettings-hiddenmltools): 
    - String
  [HiddenSageMakerImageVersionAliases](#cfn-sagemaker-userprofile-studiowebportalsettings-hiddensagemakerimageversionaliases): 
    - HiddenSageMakerImage
```

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

`HiddenAppTypes`  <a name="cfn-sagemaker-userprofile-studiowebportalsettings-hiddenapptypes"></a>
The [Applications supported in Studio](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-updated-apps.html) that are hidden from the Studio left navigation pane.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HiddenInstanceTypes`  <a name="cfn-sagemaker-userprofile-studiowebportalsettings-hiddeninstancetypes"></a>
 The instance types you are hiding from the Studio user interface.   
*Required*: No  
*Type*: Array of String  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HiddenMlTools`  <a name="cfn-sagemaker-userprofile-studiowebportalsettings-hiddenmltools"></a>
The machine learning tools that are hidden from the Studio left navigation pane.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HiddenSageMakerImageVersionAliases`  <a name="cfn-sagemaker-userprofile-studiowebportalsettings-hiddensagemakerimageversionaliases"></a>
 The version aliases you are hiding from the Studio user interface.   
*Required*: No  
*Type*: Array of [HiddenSageMakerImage](aws-properties-sagemaker-userprofile-hiddensagemakerimage.md)  
*Minimum*: `0`  
*Maximum*: `5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker AWS resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see [AddTags](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).

For more information on adding metadata to your AWS resources with tagging, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). For advice on best practices for managing AWS resources with tagging, see [Tagging Best Practices: Implement an Effective AWS Resource Tagging Strategy](https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf).

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

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

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

```
{
  "[Key](#cfn-sagemaker-userprofile-tag-key)" : String,
  "[Value](#cfn-sagemaker-userprofile-tag-value)" : String
}
```

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

```
  [Key](#cfn-sagemaker-userprofile-tag-key): String
  [Value](#cfn-sagemaker-userprofile-tag-value): String
```

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

`Key`  <a name="cfn-sagemaker-userprofile-tag-key"></a>
The tag key. Tag keys must be unique per resource.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Value`  <a name="cfn-sagemaker-userprofile-tag-value"></a>
The tag value.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

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

A collection of settings that apply to users of Amazon SageMaker Studio. These settings are specified when the [CreateUserProfile](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html) API is called, and as `DefaultUserSettings` when the [CreateDomain](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html) API is called.

`SecurityGroups` is aggregated when specified in both calls. For all other settings in `UserSettings`, the values specified in `CreateUserProfile` take precedence over those specified in `CreateDomain`.

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

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

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

```
{
  "[AutoMountHomeEFS](#cfn-sagemaker-userprofile-usersettings-automounthomeefs)" : String,
  "[CodeEditorAppSettings](#cfn-sagemaker-userprofile-usersettings-codeeditorappsettings)" : CodeEditorAppSettings,
  "[CustomFileSystemConfigs](#cfn-sagemaker-userprofile-usersettings-customfilesystemconfigs)" : [ CustomFileSystemConfig, ... ],
  "[CustomPosixUserConfig](#cfn-sagemaker-userprofile-usersettings-customposixuserconfig)" : CustomPosixUserConfig,
  "[DefaultLandingUri](#cfn-sagemaker-userprofile-usersettings-defaultlandinguri)" : String,
  "[ExecutionRole](#cfn-sagemaker-userprofile-usersettings-executionrole)" : String,
  "[JupyterLabAppSettings](#cfn-sagemaker-userprofile-usersettings-jupyterlabappsettings)" : JupyterLabAppSettings,
  "[JupyterServerAppSettings](#cfn-sagemaker-userprofile-usersettings-jupyterserverappsettings)" : JupyterServerAppSettings,
  "[KernelGatewayAppSettings](#cfn-sagemaker-userprofile-usersettings-kernelgatewayappsettings)" : KernelGatewayAppSettings,
  "[RStudioServerProAppSettings](#cfn-sagemaker-userprofile-usersettings-rstudioserverproappsettings)" : RStudioServerProAppSettings,
  "[SecurityGroups](#cfn-sagemaker-userprofile-usersettings-securitygroups)" : [ String, ... ],
  "[SharingSettings](#cfn-sagemaker-userprofile-usersettings-sharingsettings)" : SharingSettings,
  "[SpaceStorageSettings](#cfn-sagemaker-userprofile-usersettings-spacestoragesettings)" : DefaultSpaceStorageSettings,
  "[StudioWebPortal](#cfn-sagemaker-userprofile-usersettings-studiowebportal)" : String,
  "[StudioWebPortalSettings](#cfn-sagemaker-userprofile-usersettings-studiowebportalsettings)" : StudioWebPortalSettings
}
```

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

```
  [AutoMountHomeEFS](#cfn-sagemaker-userprofile-usersettings-automounthomeefs): String
  [CodeEditorAppSettings](#cfn-sagemaker-userprofile-usersettings-codeeditorappsettings): 
    CodeEditorAppSettings
  [CustomFileSystemConfigs](#cfn-sagemaker-userprofile-usersettings-customfilesystemconfigs): 
    - CustomFileSystemConfig
  [CustomPosixUserConfig](#cfn-sagemaker-userprofile-usersettings-customposixuserconfig): 
    CustomPosixUserConfig
  [DefaultLandingUri](#cfn-sagemaker-userprofile-usersettings-defaultlandinguri): String
  [ExecutionRole](#cfn-sagemaker-userprofile-usersettings-executionrole): String
  [JupyterLabAppSettings](#cfn-sagemaker-userprofile-usersettings-jupyterlabappsettings): 
    JupyterLabAppSettings
  [JupyterServerAppSettings](#cfn-sagemaker-userprofile-usersettings-jupyterserverappsettings): 
    JupyterServerAppSettings
  [KernelGatewayAppSettings](#cfn-sagemaker-userprofile-usersettings-kernelgatewayappsettings): 
    KernelGatewayAppSettings
  [RStudioServerProAppSettings](#cfn-sagemaker-userprofile-usersettings-rstudioserverproappsettings): 
    RStudioServerProAppSettings
  [SecurityGroups](#cfn-sagemaker-userprofile-usersettings-securitygroups): 
    - String
  [SharingSettings](#cfn-sagemaker-userprofile-usersettings-sharingsettings): 
    SharingSettings
  [SpaceStorageSettings](#cfn-sagemaker-userprofile-usersettings-spacestoragesettings): 
    DefaultSpaceStorageSettings
  [StudioWebPortal](#cfn-sagemaker-userprofile-usersettings-studiowebportal): String
  [StudioWebPortalSettings](#cfn-sagemaker-userprofile-usersettings-studiowebportalsettings): 
    StudioWebPortalSettings
```

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

`AutoMountHomeEFS`  <a name="cfn-sagemaker-userprofile-usersettings-automounthomeefs"></a>
Indicates whether auto-mounting of an EFS volume is supported for the user profile. The `DefaultAsDomain` value is only supported for user profiles. Do not use the `DefaultAsDomain` value when setting this parameter for a domain.  
SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.  
*Required*: No  
*Type*: String  
*Allowed values*: `Enabled | Disabled | DefaultAsDomain`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CodeEditorAppSettings`  <a name="cfn-sagemaker-userprofile-usersettings-codeeditorappsettings"></a>
The Code Editor application settings.  
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.  
*Required*: No  
*Type*: [CodeEditorAppSettings](aws-properties-sagemaker-userprofile-codeeditorappsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CustomFileSystemConfigs`  <a name="cfn-sagemaker-userprofile-usersettings-customfilesystemconfigs"></a>
The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker AI Studio.  
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.  
*Required*: No  
*Type*: Array of [CustomFileSystemConfig](aws-properties-sagemaker-userprofile-customfilesystemconfig.md)  
*Minimum*: `0`  
*Maximum*: `2`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CustomPosixUserConfig`  <a name="cfn-sagemaker-userprofile-usersettings-customposixuserconfig"></a>
Details about the POSIX identity that is used for file system operations.  
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.  
*Required*: No  
*Type*: [CustomPosixUserConfig](aws-properties-sagemaker-userprofile-customposixuserconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DefaultLandingUri`  <a name="cfn-sagemaker-userprofile-usersettings-defaultlandinguri"></a>
The default experience that the user is directed to when accessing the domain. The supported values are:  
+ `studio::`: Indicates that Studio is the default experience. This value can only be passed if `StudioWebPortal` is set to `ENABLED`.
+ `app:JupyterServer:`: Indicates that Studio Classic is the default experience.
*Required*: No  
*Type*: String  
*Maximum*: `1023`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExecutionRole`  <a name="cfn-sagemaker-userprofile-usersettings-executionrole"></a>
The execution role for the user.  
SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$`  
*Minimum*: `20`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`JupyterLabAppSettings`  <a name="cfn-sagemaker-userprofile-usersettings-jupyterlabappsettings"></a>
The settings for the JupyterLab application.  
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.  
*Required*: No  
*Type*: [JupyterLabAppSettings](aws-properties-sagemaker-userprofile-jupyterlabappsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`JupyterServerAppSettings`  <a name="cfn-sagemaker-userprofile-usersettings-jupyterserverappsettings"></a>
The Jupyter server's app settings.  
*Required*: No  
*Type*: [JupyterServerAppSettings](aws-properties-sagemaker-userprofile-jupyterserverappsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KernelGatewayAppSettings`  <a name="cfn-sagemaker-userprofile-usersettings-kernelgatewayappsettings"></a>
The kernel gateway app settings.  
*Required*: No  
*Type*: [KernelGatewayAppSettings](aws-properties-sagemaker-userprofile-kernelgatewayappsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RStudioServerProAppSettings`  <a name="cfn-sagemaker-userprofile-usersettings-rstudioserverproappsettings"></a>
A collection of settings that configure user interaction with the `RStudioServerPro` app.  
*Required*: No  
*Type*: [RStudioServerProAppSettings](aws-properties-sagemaker-userprofile-rstudioserverproappsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecurityGroups`  <a name="cfn-sagemaker-userprofile-usersettings-securitygroups"></a>
The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.  
Optional when the `CreateDomain.AppNetworkAccessType` parameter is set to `PublicInternetOnly`.  
Required when the `CreateDomain.AppNetworkAccessType` parameter is set to `VpcOnly`, unless specified as part of the `DefaultUserSettings` for the domain.  
Amazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.  
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `0`  
*Maximum*: `32 | 5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SharingSettings`  <a name="cfn-sagemaker-userprofile-usersettings-sharingsettings"></a>
Specifies options for sharing Amazon SageMaker AI Studio notebooks.  
*Required*: No  
*Type*: [SharingSettings](aws-properties-sagemaker-userprofile-sharingsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SpaceStorageSettings`  <a name="cfn-sagemaker-userprofile-usersettings-spacestoragesettings"></a>
The storage settings for a space.  
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.  
*Required*: No  
*Type*: [DefaultSpaceStorageSettings](aws-properties-sagemaker-userprofile-defaultspacestoragesettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StudioWebPortal`  <a name="cfn-sagemaker-userprofile-usersettings-studiowebportal"></a>
Whether the user can access Studio. If this value is set to `DISABLED`, the user cannot access Studio, even if that is the default experience for the domain.  
*Required*: No  
*Type*: String  
*Allowed values*: `ENABLED | DISABLED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StudioWebPortalSettings`  <a name="cfn-sagemaker-userprofile-usersettings-studiowebportalsettings"></a>
Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.  
*Required*: No  
*Type*: [StudioWebPortalSettings](aws-properties-sagemaker-userprofile-studiowebportalsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)