Class CfnUserProfilePropsMixin.UserSettingsProperty

A collection of settings that apply to users of Amazon SageMaker Studio.

Inheritance

object

CfnUserProfilePropsMixin.UserSettingsProperty

Implements

CfnUserProfilePropsMixin.IUserSettingsProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnUserProfilePropsMixin.UserSettingsProperty : CfnUserProfilePropsMixin.IUserSettingsProperty

Syntax (vb)

Public Class CfnUserProfilePropsMixin.UserSettingsProperty Implements CfnUserProfilePropsMixin.IUserSettingsProperty

Remarks

These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain 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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.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 userSettingsProperty = new UserSettingsProperty {
                 AutoMountHomeEfs = "autoMountHomeEfs",
                 CodeEditorAppSettings = new CodeEditorAppSettingsProperty {
                     AppLifecycleManagement = new AppLifecycleManagementProperty {
                         IdleSettings = new IdleSettingsProperty {
                             IdleTimeoutInMinutes = 123,
                             LifecycleManagement = "lifecycleManagement",
                             MaxIdleTimeoutInMinutes = 123,
                             MinIdleTimeoutInMinutes = 123
                         }
                     },
                     BuiltInLifecycleConfigArn = "builtInLifecycleConfigArn",
                     CustomImages = new [] { new CustomImageProperty {
                         AppImageConfigName = "appImageConfigName",
                         ImageName = "imageName",
                         ImageVersionNumber = 123
                     } },
                     DefaultResourceSpec = new ResourceSpecProperty {
                         InstanceType = "instanceType",
                         LifecycleConfigArn = "lifecycleConfigArn",
                         SageMakerImageArn = "sageMakerImageArn",
                         SageMakerImageVersionArn = "sageMakerImageVersionArn"
                     },
                     LifecycleConfigArns = new [] { "lifecycleConfigArns" }
                 },
                 CustomFileSystemConfigs = new [] { new CustomFileSystemConfigProperty {
                     EfsFileSystemConfig = new EFSFileSystemConfigProperty {
                         FileSystemId = "fileSystemId",
                         FileSystemPath = "fileSystemPath"
                     },
                     FSxLustreFileSystemConfig = new FSxLustreFileSystemConfigProperty {
                         FileSystemId = "fileSystemId",
                         FileSystemPath = "fileSystemPath"
                     },
                     S3FileSystemConfig = new S3FileSystemConfigProperty {
                         MountPath = "mountPath",
                         S3Uri = "s3Uri"
                     }
                 } },
                 CustomPosixUserConfig = new CustomPosixUserConfigProperty {
                     Gid = 123,
                     Uid = 123
                 },
                 DefaultLandingUri = "defaultLandingUri",
                 ExecutionRole = "executionRole",
                 JupyterLabAppSettings = new JupyterLabAppSettingsProperty {
                     AppLifecycleManagement = new AppLifecycleManagementProperty {
                         IdleSettings = new IdleSettingsProperty {
                             IdleTimeoutInMinutes = 123,
                             LifecycleManagement = "lifecycleManagement",
                             MaxIdleTimeoutInMinutes = 123,
                             MinIdleTimeoutInMinutes = 123
                         }
                     },
                     BuiltInLifecycleConfigArn = "builtInLifecycleConfigArn",
                     CodeRepositories = new [] { new CodeRepositoryProperty {
                         RepositoryUrl = "repositoryUrl"
                     } },
                     CustomImages = new [] { new CustomImageProperty {
                         AppImageConfigName = "appImageConfigName",
                         ImageName = "imageName",
                         ImageVersionNumber = 123
                     } },
                     DefaultResourceSpec = new ResourceSpecProperty {
                         InstanceType = "instanceType",
                         LifecycleConfigArn = "lifecycleConfigArn",
                         SageMakerImageArn = "sageMakerImageArn",
                         SageMakerImageVersionArn = "sageMakerImageVersionArn"
                     },
                     LifecycleConfigArns = new [] { "lifecycleConfigArns" }
                 },
                 JupyterServerAppSettings = new JupyterServerAppSettingsProperty {
                     DefaultResourceSpec = new ResourceSpecProperty {
                         InstanceType = "instanceType",
                         LifecycleConfigArn = "lifecycleConfigArn",
                         SageMakerImageArn = "sageMakerImageArn",
                         SageMakerImageVersionArn = "sageMakerImageVersionArn"
                     },
                     LifecycleConfigArns = new [] { "lifecycleConfigArns" }
                 },
                 KernelGatewayAppSettings = new KernelGatewayAppSettingsProperty {
                     CustomImages = new [] { new CustomImageProperty {
                         AppImageConfigName = "appImageConfigName",
                         ImageName = "imageName",
                         ImageVersionNumber = 123
                     } },
                     DefaultResourceSpec = new ResourceSpecProperty {
                         InstanceType = "instanceType",
                         LifecycleConfigArn = "lifecycleConfigArn",
                         SageMakerImageArn = "sageMakerImageArn",
                         SageMakerImageVersionArn = "sageMakerImageVersionArn"
                     },
                     LifecycleConfigArns = new [] { "lifecycleConfigArns" }
                 },
                 RStudioServerProAppSettings = new RStudioServerProAppSettingsProperty {
                     AccessStatus = "accessStatus",
                     UserGroup = "userGroup"
                 },
                 SecurityGroups = new [] { "securityGroups" },
                 SharingSettings = new SharingSettingsProperty {
                     NotebookOutputOption = "notebookOutputOption",
                     S3KmsKeyId = "s3KmsKeyId",
                     S3OutputPath = "s3OutputPath"
                 },
                 SpaceStorageSettings = new DefaultSpaceStorageSettingsProperty {
                     DefaultEbsStorageSettings = new DefaultEbsStorageSettingsProperty {
                         DefaultEbsVolumeSizeInGb = 123,
                         MaximumEbsVolumeSizeInGb = 123
                     }
                 },
                 StudioWebPortal = "studioWebPortal",
                 StudioWebPortalSettings = new StudioWebPortalSettingsProperty {
                     HiddenAppTypes = new [] { "hiddenAppTypes" },
                     HiddenInstanceTypes = new [] { "hiddenInstanceTypes" },
                     HiddenMlTools = new [] { "hiddenMlTools" },
                     HiddenSageMakerImageVersionAliases = new [] { new HiddenSageMakerImageProperty {
                         SageMakerImageName = "sageMakerImageName",
                         VersionAliases = new [] { "versionAliases" }
                     } }
                 }
             };

Synopsis

Constructors

UserSettingsProperty()

A collection of settings that apply to users of Amazon SageMaker Studio.

Properties

AutoMountHomeEfs	Indicates whether auto-mounting of an EFS volume is supported for the user profile.
CodeEditorAppSettings	The Code Editor application settings.
CustomFileSystemConfigs	The settings for assigning a custom file system to a user profile.
CustomPosixUserConfig	Details about the POSIX identity that is used for file system operations.
DefaultLandingUri	The default experience that the user is directed to when accessing the domain. The supported values are:.
ExecutionRole	The execution role for the user.
JupyterLabAppSettings	The settings for the JupyterLab application.
JupyterServerAppSettings	The Jupyter server's app settings.
KernelGatewayAppSettings	The kernel gateway app settings.
RStudioServerProAppSettings	A collection of settings that configure user interaction with the RStudioServerPro app.
SecurityGroups	The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
SharingSettings	Specifies options for sharing Amazon SageMaker AI Studio notebooks.
SpaceStorageSettings	The storage settings for a space.
StudioWebPortal	Whether the user can access Studio.
StudioWebPortalSettings	Studio settings.

Constructors

UserSettingsProperty()

A collection of settings that apply to users of Amazon SageMaker Studio.

public UserSettingsProperty()

Remarks

These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain 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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.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 userSettingsProperty = new UserSettingsProperty {
                 AutoMountHomeEfs = "autoMountHomeEfs",
                 CodeEditorAppSettings = new CodeEditorAppSettingsProperty {
                     AppLifecycleManagement = new AppLifecycleManagementProperty {
                         IdleSettings = new IdleSettingsProperty {
                             IdleTimeoutInMinutes = 123,
                             LifecycleManagement = "lifecycleManagement",
                             MaxIdleTimeoutInMinutes = 123,
                             MinIdleTimeoutInMinutes = 123
                         }
                     },
                     BuiltInLifecycleConfigArn = "builtInLifecycleConfigArn",
                     CustomImages = new [] { new CustomImageProperty {
                         AppImageConfigName = "appImageConfigName",
                         ImageName = "imageName",
                         ImageVersionNumber = 123
                     } },
                     DefaultResourceSpec = new ResourceSpecProperty {
                         InstanceType = "instanceType",
                         LifecycleConfigArn = "lifecycleConfigArn",
                         SageMakerImageArn = "sageMakerImageArn",
                         SageMakerImageVersionArn = "sageMakerImageVersionArn"
                     },
                     LifecycleConfigArns = new [] { "lifecycleConfigArns" }
                 },
                 CustomFileSystemConfigs = new [] { new CustomFileSystemConfigProperty {
                     EfsFileSystemConfig = new EFSFileSystemConfigProperty {
                         FileSystemId = "fileSystemId",
                         FileSystemPath = "fileSystemPath"
                     },
                     FSxLustreFileSystemConfig = new FSxLustreFileSystemConfigProperty {
                         FileSystemId = "fileSystemId",
                         FileSystemPath = "fileSystemPath"
                     },
                     S3FileSystemConfig = new S3FileSystemConfigProperty {
                         MountPath = "mountPath",
                         S3Uri = "s3Uri"
                     }
                 } },
                 CustomPosixUserConfig = new CustomPosixUserConfigProperty {
                     Gid = 123,
                     Uid = 123
                 },
                 DefaultLandingUri = "defaultLandingUri",
                 ExecutionRole = "executionRole",
                 JupyterLabAppSettings = new JupyterLabAppSettingsProperty {
                     AppLifecycleManagement = new AppLifecycleManagementProperty {
                         IdleSettings = new IdleSettingsProperty {
                             IdleTimeoutInMinutes = 123,
                             LifecycleManagement = "lifecycleManagement",
                             MaxIdleTimeoutInMinutes = 123,
                             MinIdleTimeoutInMinutes = 123
                         }
                     },
                     BuiltInLifecycleConfigArn = "builtInLifecycleConfigArn",
                     CodeRepositories = new [] { new CodeRepositoryProperty {
                         RepositoryUrl = "repositoryUrl"
                     } },
                     CustomImages = new [] { new CustomImageProperty {
                         AppImageConfigName = "appImageConfigName",
                         ImageName = "imageName",
                         ImageVersionNumber = 123
                     } },
                     DefaultResourceSpec = new ResourceSpecProperty {
                         InstanceType = "instanceType",
                         LifecycleConfigArn = "lifecycleConfigArn",
                         SageMakerImageArn = "sageMakerImageArn",
                         SageMakerImageVersionArn = "sageMakerImageVersionArn"
                     },
                     LifecycleConfigArns = new [] { "lifecycleConfigArns" }
                 },
                 JupyterServerAppSettings = new JupyterServerAppSettingsProperty {
                     DefaultResourceSpec = new ResourceSpecProperty {
                         InstanceType = "instanceType",
                         LifecycleConfigArn = "lifecycleConfigArn",
                         SageMakerImageArn = "sageMakerImageArn",
                         SageMakerImageVersionArn = "sageMakerImageVersionArn"
                     },
                     LifecycleConfigArns = new [] { "lifecycleConfigArns" }
                 },
                 KernelGatewayAppSettings = new KernelGatewayAppSettingsProperty {
                     CustomImages = new [] { new CustomImageProperty {
                         AppImageConfigName = "appImageConfigName",
                         ImageName = "imageName",
                         ImageVersionNumber = 123
                     } },
                     DefaultResourceSpec = new ResourceSpecProperty {
                         InstanceType = "instanceType",
                         LifecycleConfigArn = "lifecycleConfigArn",
                         SageMakerImageArn = "sageMakerImageArn",
                         SageMakerImageVersionArn = "sageMakerImageVersionArn"
                     },
                     LifecycleConfigArns = new [] { "lifecycleConfigArns" }
                 },
                 RStudioServerProAppSettings = new RStudioServerProAppSettingsProperty {
                     AccessStatus = "accessStatus",
                     UserGroup = "userGroup"
                 },
                 SecurityGroups = new [] { "securityGroups" },
                 SharingSettings = new SharingSettingsProperty {
                     NotebookOutputOption = "notebookOutputOption",
                     S3KmsKeyId = "s3KmsKeyId",
                     S3OutputPath = "s3OutputPath"
                 },
                 SpaceStorageSettings = new DefaultSpaceStorageSettingsProperty {
                     DefaultEbsStorageSettings = new DefaultEbsStorageSettingsProperty {
                         DefaultEbsVolumeSizeInGb = 123,
                         MaximumEbsVolumeSizeInGb = 123
                     }
                 },
                 StudioWebPortal = "studioWebPortal",
                 StudioWebPortalSettings = new StudioWebPortalSettingsProperty {
                     HiddenAppTypes = new [] { "hiddenAppTypes" },
                     HiddenInstanceTypes = new [] { "hiddenInstanceTypes" },
                     HiddenMlTools = new [] { "hiddenMlTools" },
                     HiddenSageMakerImageVersionAliases = new [] { new HiddenSageMakerImageProperty {
                         SageMakerImageName = "sageMakerImageName",
                         VersionAliases = new [] { "versionAliases" }
                     } }
                 }
             };

Properties

AutoMountHomeEfs

Indicates whether auto-mounting of an EFS volume is supported for the user profile.

public string? AutoMountHomeEfs { get; set; }

Property Value

string

Remarks

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.

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

CodeEditorAppSettings

The Code Editor application settings.

public object? CodeEditorAppSettings { get; set; }

Property Value

object

Remarks

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

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

Type union: either IResolvable or CfnUserProfilePropsMixin.ICodeEditorAppSettingsProperty

CustomFileSystemConfigs

The settings for assigning a custom file system to a user profile.

public object? CustomFileSystemConfigs { get; set; }

Property Value

object

Remarks

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.

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

Type union: either IResolvable or (either IResolvable or CfnUserProfilePropsMixin.ICustomFileSystemConfigProperty)[]

CustomPosixUserConfig

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

public object? CustomPosixUserConfig { get; set; }

Property Value

object

Remarks

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

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

Type union: either IResolvable or CfnUserProfilePropsMixin.ICustomPosixUserConfigProperty

DefaultLandingUri

The default experience that the user is directed to when accessing the domain. The supported values are:.

public string? DefaultLandingUri { get; set; }

Property Value

string

Remarks

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

ExecutionRole

The execution role for the user.

public string? ExecutionRole { get; set; }

Property Value

string

Remarks

SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.

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

JupyterLabAppSettings

The settings for the JupyterLab application.

public object? JupyterLabAppSettings { get; set; }

Property Value

object

Remarks

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

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

Type union: either IResolvable or CfnUserProfilePropsMixin.IJupyterLabAppSettingsProperty

JupyterServerAppSettings

The Jupyter server's app settings.

public object? JupyterServerAppSettings { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnUserProfilePropsMixin.IJupyterServerAppSettingsProperty

KernelGatewayAppSettings

The kernel gateway app settings.

public object? KernelGatewayAppSettings { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnUserProfilePropsMixin.IKernelGatewayAppSettingsProperty

RStudioServerProAppSettings

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

public object? RStudioServerProAppSettings { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnUserProfilePropsMixin.IRStudioServerProAppSettingsProperty

SecurityGroups

The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

public string[]? SecurityGroups { get; set; }

Property Value

string[]

Remarks

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.

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

SharingSettings

Specifies options for sharing Amazon SageMaker AI Studio notebooks.

public object? SharingSettings { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnUserProfilePropsMixin.ISharingSettingsProperty

SpaceStorageSettings

The storage settings for a space.

public object? SpaceStorageSettings { get; set; }

Property Value

object

Remarks

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

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

Type union: either IResolvable or CfnUserProfilePropsMixin.IDefaultSpaceStorageSettingsProperty

StudioWebPortal

Whether the user can access Studio.

public string? StudioWebPortal { get; set; }

Property Value

string

Remarks

If this value is set to DISABLED , the user cannot access Studio, even if that is the default experience for the domain.

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

StudioWebPortalSettings

Studio settings.

public object? StudioWebPortalSettings { get; set; }

Property Value

object

Remarks

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

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

Type union: either IResolvable or CfnUserProfilePropsMixin.IStudioWebPortalSettingsProperty

Implements

CfnUserProfilePropsMixin.IUserSettingsProperty