Skip to content
v2.277.0

UserSettingsProperty Struct ​

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

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 .

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const userSettingsProperty: sagemaker.CfnUserProfile.UserSettingsProperty = {
  autoMountHomeEfs: 'autoMountHomeEfs',
  codeEditorAppSettings: {
    appLifecycleManagement: {
      idleSettings: {
        idleTimeoutInMinutes: 123,
        lifecycleManagement: 'lifecycleManagement',
        maxIdleTimeoutInMinutes: 123,
        minIdleTimeoutInMinutes: 123,
      },
    },
    builtInLifecycleConfigArn: 'builtInLifecycleConfigArn',
    customImages: [{
      appImageConfigName: 'appImageConfigName',
      imageName: 'imageName',

      // the properties below are optional
      imageVersionNumber: 123,
    }],
    defaultResourceSpec: {
      instanceType: 'instanceType',
      lifecycleConfigArn: 'lifecycleConfigArn',
      sageMakerImageArn: 'sageMakerImageArn',
      sageMakerImageVersionArn: 'sageMakerImageVersionArn',
      trainingPlanArn: 'trainingPlanArn',
    },
    lifecycleConfigArns: ['lifecycleConfigArns'],
  },
  customFileSystemConfigs: [{
    efsFileSystemConfig: {
      fileSystemId: 'fileSystemId',

      // the properties below are optional
      fileSystemPath: 'fileSystemPath',
    },
    fSxLustreFileSystemConfig: {
      fileSystemId: 'fileSystemId',

      // the properties below are optional
      fileSystemPath: 'fileSystemPath',
    },
    s3FileSystemConfig: {
      mountPath: 'mountPath',
      s3Uri: 's3Uri',
    },
  }],
  customPosixUserConfig: {
    gid: 123,
    uid: 123,
  },
  defaultLandingUri: 'defaultLandingUri',
  executionRole: 'executionRole',
  jupyterLabAppSettings: {
    appLifecycleManagement: {
      idleSettings: {
        idleTimeoutInMinutes: 123,
        lifecycleManagement: 'lifecycleManagement',
        maxIdleTimeoutInMinutes: 123,
        minIdleTimeoutInMinutes: 123,
      },
    },
    builtInLifecycleConfigArn: 'builtInLifecycleConfigArn',
    codeRepositories: [{
      repositoryUrl: 'repositoryUrl',
    }],
    customImages: [{
      appImageConfigName: 'appImageConfigName',
      imageName: 'imageName',

      // the properties below are optional
      imageVersionNumber: 123,
    }],
    defaultResourceSpec: {
      instanceType: 'instanceType',
      lifecycleConfigArn: 'lifecycleConfigArn',
      sageMakerImageArn: 'sageMakerImageArn',
      sageMakerImageVersionArn: 'sageMakerImageVersionArn',
      trainingPlanArn: 'trainingPlanArn',
    },
    emrSettings: {
      assumableRoleArns: ['assumableRoleArns'],
      executionRoleArns: ['executionRoleArns'],
    },
    lifecycleConfigArns: ['lifecycleConfigArns'],
  },
  jupyterServerAppSettings: {
    defaultResourceSpec: {
      instanceType: 'instanceType',
      lifecycleConfigArn: 'lifecycleConfigArn',
      sageMakerImageArn: 'sageMakerImageArn',
      sageMakerImageVersionArn: 'sageMakerImageVersionArn',
      trainingPlanArn: 'trainingPlanArn',
    },
    lifecycleConfigArns: ['lifecycleConfigArns'],
  },
  kernelGatewayAppSettings: {
    customImages: [{
      appImageConfigName: 'appImageConfigName',
      imageName: 'imageName',

      // the properties below are optional
      imageVersionNumber: 123,
    }],
    defaultResourceSpec: {
      instanceType: 'instanceType',
      lifecycleConfigArn: 'lifecycleConfigArn',
      sageMakerImageArn: 'sageMakerImageArn',
      sageMakerImageVersionArn: 'sageMakerImageVersionArn',
      trainingPlanArn: 'trainingPlanArn',
    },
    lifecycleConfigArns: ['lifecycleConfigArns'],
  },
  rStudioServerProAppSettings: {
    accessStatus: 'accessStatus',
    userGroup: 'userGroup',
  },
  securityGroups: ['securityGroups'],
  sharingSettings: {
    notebookOutputOption: 'notebookOutputOption',
    s3KmsKeyId: 's3KmsKeyId',
    s3OutputPath: 's3OutputPath',
  },
  spaceStorageSettings: {
    defaultEbsStorageSettings: {
      defaultEbsVolumeSizeInGb: 123,
      maximumEbsVolumeSizeInGb: 123,
    },
  },
  studioWebPortal: 'studioWebPortal',
  studioWebPortalSettings: {
    hiddenAppTypes: ['hiddenAppTypes'],
    hiddenInstanceTypes: ['hiddenInstanceTypes'],
    hiddenMlTools: ['hiddenMlTools'],
    hiddenSageMakerImageVersionAliases: [{
      sageMakerImageName: 'sageMakerImageName',
      versionAliases: ['versionAliases'],
    }],
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

user_settings_property = sagemaker.CfnUserProfile.UserSettingsProperty(
    auto_mount_home_efs="autoMountHomeEfs",
    code_editor_app_settings=sagemaker.CfnUserProfile.CodeEditorAppSettingsProperty(
        app_lifecycle_management=sagemaker.CfnUserProfile.AppLifecycleManagementProperty(
            idle_settings=sagemaker.CfnUserProfile.IdleSettingsProperty(
                idle_timeout_in_minutes=123,
                lifecycle_management="lifecycleManagement",
                max_idle_timeout_in_minutes=123,
                min_idle_timeout_in_minutes=123
            )
        ),
        built_in_lifecycle_config_arn="builtInLifecycleConfigArn",
        custom_images=[sagemaker.CfnUserProfile.CustomImageProperty(
            app_image_config_name="appImageConfigName",
            image_name="imageName",

            # the properties below are optional
            image_version_number=123
        )],
        default_resource_spec=sagemaker.CfnUserProfile.ResourceSpecProperty(
            instance_type="instanceType",
            lifecycle_config_arn="lifecycleConfigArn",
            sage_maker_image_arn="sageMakerImageArn",
            sage_maker_image_version_arn="sageMakerImageVersionArn",
            training_plan_arn="trainingPlanArn"
        ),
        lifecycle_config_arns=["lifecycleConfigArns"]
    ),
    custom_file_system_configs=[sagemaker.CfnUserProfile.CustomFileSystemConfigProperty(
        efs_file_system_config=sagemaker.CfnUserProfile.EFSFileSystemConfigProperty(
            file_system_id="fileSystemId",

            # the properties below are optional
            file_system_path="fileSystemPath"
        ),
        f_sx_lustre_file_system_config=sagemaker.CfnUserProfile.FSxLustreFileSystemConfigProperty(
            file_system_id="fileSystemId",

            # the properties below are optional
            file_system_path="fileSystemPath"
        ),
        s3_file_system_config=sagemaker.CfnUserProfile.S3FileSystemConfigProperty(
            mount_path="mountPath",
            s3_uri="s3Uri"
        )
    )],
    custom_posix_user_config=sagemaker.CfnUserProfile.CustomPosixUserConfigProperty(
        gid=123,
        uid=123
    ),
    default_landing_uri="defaultLandingUri",
    execution_role="executionRole",
    jupyter_lab_app_settings=sagemaker.CfnUserProfile.JupyterLabAppSettingsProperty(
        app_lifecycle_management=sagemaker.CfnUserProfile.AppLifecycleManagementProperty(
            idle_settings=sagemaker.CfnUserProfile.IdleSettingsProperty(
                idle_timeout_in_minutes=123,
                lifecycle_management="lifecycleManagement",
                max_idle_timeout_in_minutes=123,
                min_idle_timeout_in_minutes=123
            )
        ),
        built_in_lifecycle_config_arn="builtInLifecycleConfigArn",
        code_repositories=[sagemaker.CfnUserProfile.CodeRepositoryProperty(
            repository_url="repositoryUrl"
        )],
        custom_images=[sagemaker.CfnUserProfile.CustomImageProperty(
            app_image_config_name="appImageConfigName",
            image_name="imageName",

            # the properties below are optional
            image_version_number=123
        )],
        default_resource_spec=sagemaker.CfnUserProfile.ResourceSpecProperty(
            instance_type="instanceType",
            lifecycle_config_arn="lifecycleConfigArn",
            sage_maker_image_arn="sageMakerImageArn",
            sage_maker_image_version_arn="sageMakerImageVersionArn",
            training_plan_arn="trainingPlanArn"
        ),
        emr_settings=sagemaker.CfnUserProfile.EmrSettingsProperty(
            assumable_role_arns=["assumableRoleArns"],
            execution_role_arns=["executionRoleArns"]
        ),
        lifecycle_config_arns=["lifecycleConfigArns"]
    ),
    jupyter_server_app_settings=sagemaker.CfnUserProfile.JupyterServerAppSettingsProperty(
        default_resource_spec=sagemaker.CfnUserProfile.ResourceSpecProperty(
            instance_type="instanceType",
            lifecycle_config_arn="lifecycleConfigArn",
            sage_maker_image_arn="sageMakerImageArn",
            sage_maker_image_version_arn="sageMakerImageVersionArn",
            training_plan_arn="trainingPlanArn"
        ),
        lifecycle_config_arns=["lifecycleConfigArns"]
    ),
    kernel_gateway_app_settings=sagemaker.CfnUserProfile.KernelGatewayAppSettingsProperty(
        custom_images=[sagemaker.CfnUserProfile.CustomImageProperty(
            app_image_config_name="appImageConfigName",
            image_name="imageName",

            # the properties below are optional
            image_version_number=123
        )],
        default_resource_spec=sagemaker.CfnUserProfile.ResourceSpecProperty(
            instance_type="instanceType",
            lifecycle_config_arn="lifecycleConfigArn",
            sage_maker_image_arn="sageMakerImageArn",
            sage_maker_image_version_arn="sageMakerImageVersionArn",
            training_plan_arn="trainingPlanArn"
        ),
        lifecycle_config_arns=["lifecycleConfigArns"]
    ),
    r_studio_server_pro_app_settings=sagemaker.CfnUserProfile.RStudioServerProAppSettingsProperty(
        access_status="accessStatus",
        user_group="userGroup"
    ),
    security_groups=["securityGroups"],
    sharing_settings=sagemaker.CfnUserProfile.SharingSettingsProperty(
        notebook_output_option="notebookOutputOption",
        s3_kms_key_id="s3KmsKeyId",
        s3_output_path="s3OutputPath"
    ),
    space_storage_settings=sagemaker.CfnUserProfile.DefaultSpaceStorageSettingsProperty(
        default_ebs_storage_settings=sagemaker.CfnUserProfile.DefaultEbsStorageSettingsProperty(
            default_ebs_volume_size_in_gb=123,
            maximum_ebs_volume_size_in_gb=123
        )
    ),
    studio_web_portal="studioWebPortal",
    studio_web_portal_settings=sagemaker.CfnUserProfile.StudioWebPortalSettingsProperty(
        hidden_app_types=["hiddenAppTypes"],
        hidden_instance_types=["hiddenInstanceTypes"],
        hidden_ml_tools=["hiddenMlTools"],
        hidden_sage_maker_image_version_aliases=[sagemaker.CfnUserProfile.HiddenSageMakerImageProperty(
            sage_maker_image_name="sageMakerImageName",
            version_aliases=["versionAliases"]
        )]
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.sagemaker.*;

UserSettingsProperty userSettingsProperty = UserSettingsProperty.builder()
        .autoMountHomeEfs("autoMountHomeEfs")
        .codeEditorAppSettings(CodeEditorAppSettingsProperty.builder()
                .appLifecycleManagement(AppLifecycleManagementProperty.builder()
                        .idleSettings(IdleSettingsProperty.builder()
                                .idleTimeoutInMinutes(123)
                                .lifecycleManagement("lifecycleManagement")
                                .maxIdleTimeoutInMinutes(123)
                                .minIdleTimeoutInMinutes(123)
                                .build())
                        .build())
                .builtInLifecycleConfigArn("builtInLifecycleConfigArn")
                .customImages(List.of(CustomImageProperty.builder()
                        .appImageConfigName("appImageConfigName")
                        .imageName("imageName")

                        // the properties below are optional
                        .imageVersionNumber(123)
                        .build()))
                .defaultResourceSpec(ResourceSpecProperty.builder()
                        .instanceType("instanceType")
                        .lifecycleConfigArn("lifecycleConfigArn")
                        .sageMakerImageArn("sageMakerImageArn")
                        .sageMakerImageVersionArn("sageMakerImageVersionArn")
                        .trainingPlanArn("trainingPlanArn")
                        .build())
                .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                .build())
        .customFileSystemConfigs(List.of(CustomFileSystemConfigProperty.builder()
                .efsFileSystemConfig(EFSFileSystemConfigProperty.builder()
                        .fileSystemId("fileSystemId")

                        // the properties below are optional
                        .fileSystemPath("fileSystemPath")
                        .build())
                .fSxLustreFileSystemConfig(FSxLustreFileSystemConfigProperty.builder()
                        .fileSystemId("fileSystemId")

                        // the properties below are optional
                        .fileSystemPath("fileSystemPath")
                        .build())
                .s3FileSystemConfig(S3FileSystemConfigProperty.builder()
                        .mountPath("mountPath")
                        .s3Uri("s3Uri")
                        .build())
                .build()))
        .customPosixUserConfig(CustomPosixUserConfigProperty.builder()
                .gid(123)
                .uid(123)
                .build())
        .defaultLandingUri("defaultLandingUri")
        .executionRole("executionRole")
        .jupyterLabAppSettings(JupyterLabAppSettingsProperty.builder()
                .appLifecycleManagement(AppLifecycleManagementProperty.builder()
                        .idleSettings(IdleSettingsProperty.builder()
                                .idleTimeoutInMinutes(123)
                                .lifecycleManagement("lifecycleManagement")
                                .maxIdleTimeoutInMinutes(123)
                                .minIdleTimeoutInMinutes(123)
                                .build())
                        .build())
                .builtInLifecycleConfigArn("builtInLifecycleConfigArn")
                .codeRepositories(List.of(CodeRepositoryProperty.builder()
                        .repositoryUrl("repositoryUrl")
                        .build()))
                .customImages(List.of(CustomImageProperty.builder()
                        .appImageConfigName("appImageConfigName")
                        .imageName("imageName")

                        // the properties below are optional
                        .imageVersionNumber(123)
                        .build()))
                .defaultResourceSpec(ResourceSpecProperty.builder()
                        .instanceType("instanceType")
                        .lifecycleConfigArn("lifecycleConfigArn")
                        .sageMakerImageArn("sageMakerImageArn")
                        .sageMakerImageVersionArn("sageMakerImageVersionArn")
                        .trainingPlanArn("trainingPlanArn")
                        .build())
                .emrSettings(EmrSettingsProperty.builder()
                        .assumableRoleArns(List.of("assumableRoleArns"))
                        .executionRoleArns(List.of("executionRoleArns"))
                        .build())
                .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                .build())
        .jupyterServerAppSettings(JupyterServerAppSettingsProperty.builder()
                .defaultResourceSpec(ResourceSpecProperty.builder()
                        .instanceType("instanceType")
                        .lifecycleConfigArn("lifecycleConfigArn")
                        .sageMakerImageArn("sageMakerImageArn")
                        .sageMakerImageVersionArn("sageMakerImageVersionArn")
                        .trainingPlanArn("trainingPlanArn")
                        .build())
                .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                .build())
        .kernelGatewayAppSettings(KernelGatewayAppSettingsProperty.builder()
                .customImages(List.of(CustomImageProperty.builder()
                        .appImageConfigName("appImageConfigName")
                        .imageName("imageName")

                        // the properties below are optional
                        .imageVersionNumber(123)
                        .build()))
                .defaultResourceSpec(ResourceSpecProperty.builder()
                        .instanceType("instanceType")
                        .lifecycleConfigArn("lifecycleConfigArn")
                        .sageMakerImageArn("sageMakerImageArn")
                        .sageMakerImageVersionArn("sageMakerImageVersionArn")
                        .trainingPlanArn("trainingPlanArn")
                        .build())
                .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                .build())
        .rStudioServerProAppSettings(RStudioServerProAppSettingsProperty.builder()
                .accessStatus("accessStatus")
                .userGroup("userGroup")
                .build())
        .securityGroups(List.of("securityGroups"))
        .sharingSettings(SharingSettingsProperty.builder()
                .notebookOutputOption("notebookOutputOption")
                .s3KmsKeyId("s3KmsKeyId")
                .s3OutputPath("s3OutputPath")
                .build())
        .spaceStorageSettings(DefaultSpaceStorageSettingsProperty.builder()
                .defaultEbsStorageSettings(DefaultEbsStorageSettingsProperty.builder()
                        .defaultEbsVolumeSizeInGb(123)
                        .maximumEbsVolumeSizeInGb(123)
                        .build())
                .build())
        .studioWebPortal("studioWebPortal")
        .studioWebPortalSettings(StudioWebPortalSettingsProperty.builder()
                .hiddenAppTypes(List.of("hiddenAppTypes"))
                .hiddenInstanceTypes(List.of("hiddenInstanceTypes"))
                .hiddenMlTools(List.of("hiddenMlTools"))
                .hiddenSageMakerImageVersionAliases(List.of(HiddenSageMakerImageProperty.builder()
                        .sageMakerImageName("sageMakerImageName")
                        .versionAliases(List.of("versionAliases"))
                        .build()))
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;

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",

            // the properties below are optional
            ImageVersionNumber = 123
        } },
        DefaultResourceSpec = new ResourceSpecProperty {
            InstanceType = "instanceType",
            LifecycleConfigArn = "lifecycleConfigArn",
            SageMakerImageArn = "sageMakerImageArn",
            SageMakerImageVersionArn = "sageMakerImageVersionArn",
            TrainingPlanArn = "trainingPlanArn"
        },
        LifecycleConfigArns = new [] { "lifecycleConfigArns" }
    },
    CustomFileSystemConfigs = new [] { new CustomFileSystemConfigProperty {
        EfsFileSystemConfig = new EFSFileSystemConfigProperty {
            FileSystemId = "fileSystemId",

            // the properties below are optional
            FileSystemPath = "fileSystemPath"
        },
        FSxLustreFileSystemConfig = new FSxLustreFileSystemConfigProperty {
            FileSystemId = "fileSystemId",

            // the properties below are optional
            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",

            // the properties below are optional
            ImageVersionNumber = 123
        } },
        DefaultResourceSpec = new ResourceSpecProperty {
            InstanceType = "instanceType",
            LifecycleConfigArn = "lifecycleConfigArn",
            SageMakerImageArn = "sageMakerImageArn",
            SageMakerImageVersionArn = "sageMakerImageVersionArn",
            TrainingPlanArn = "trainingPlanArn"
        },
        EmrSettings = new EmrSettingsProperty {
            AssumableRoleArns = new [] { "assumableRoleArns" },
            ExecutionRoleArns = new [] { "executionRoleArns" }
        },
        LifecycleConfigArns = new [] { "lifecycleConfigArns" }
    },
    JupyterServerAppSettings = new JupyterServerAppSettingsProperty {
        DefaultResourceSpec = new ResourceSpecProperty {
            InstanceType = "instanceType",
            LifecycleConfigArn = "lifecycleConfigArn",
            SageMakerImageArn = "sageMakerImageArn",
            SageMakerImageVersionArn = "sageMakerImageVersionArn",
            TrainingPlanArn = "trainingPlanArn"
        },
        LifecycleConfigArns = new [] { "lifecycleConfigArns" }
    },
    KernelGatewayAppSettings = new KernelGatewayAppSettingsProperty {
        CustomImages = new [] { new CustomImageProperty {
            AppImageConfigName = "appImageConfigName",
            ImageName = "imageName",

            // the properties below are optional
            ImageVersionNumber = 123
        } },
        DefaultResourceSpec = new ResourceSpecProperty {
            InstanceType = "instanceType",
            LifecycleConfigArn = "lifecycleConfigArn",
            SageMakerImageArn = "sageMakerImageArn",
            SageMakerImageVersionArn = "sageMakerImageVersionArn",
            TrainingPlanArn = "trainingPlanArn"
        },
        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" }
        } }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

userSettingsProperty := &UserSettingsProperty{
	AutoMountHomeEfs: jsii.String("autoMountHomeEfs"),
	CodeEditorAppSettings: &CodeEditorAppSettingsProperty{
		AppLifecycleManagement: &AppLifecycleManagementProperty{
			IdleSettings: &IdleSettingsProperty{
				IdleTimeoutInMinutes: jsii.Number(123),
				LifecycleManagement: jsii.String("lifecycleManagement"),
				MaxIdleTimeoutInMinutes: jsii.Number(123),
				MinIdleTimeoutInMinutes: jsii.Number(123),
			},
		},
		BuiltInLifecycleConfigArn: jsii.String("builtInLifecycleConfigArn"),
		CustomImages: []interface{}{
			&CustomImageProperty{
				AppImageConfigName: jsii.String("appImageConfigName"),
				ImageName: jsii.String("imageName"),

				// the properties below are optional
				ImageVersionNumber: jsii.Number(123),
			},
		},
		DefaultResourceSpec: &ResourceSpecProperty{
			InstanceType: jsii.String("instanceType"),
			LifecycleConfigArn: jsii.String("lifecycleConfigArn"),
			SageMakerImageArn: jsii.String("sageMakerImageArn"),
			SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"),
			TrainingPlanArn: jsii.String("trainingPlanArn"),
		},
		LifecycleConfigArns: []*string{
			jsii.String("lifecycleConfigArns"),
		},
	},
	CustomFileSystemConfigs: []interface{}{
		&CustomFileSystemConfigProperty{
			EfsFileSystemConfig: &EFSFileSystemConfigProperty{
				FileSystemId: jsii.String("fileSystemId"),

				// the properties below are optional
				FileSystemPath: jsii.String("fileSystemPath"),
			},
			FSxLustreFileSystemConfig: &FSxLustreFileSystemConfigProperty{
				FileSystemId: jsii.String("fileSystemId"),

				// the properties below are optional
				FileSystemPath: jsii.String("fileSystemPath"),
			},
			S3FileSystemConfig: &S3FileSystemConfigProperty{
				MountPath: jsii.String("mountPath"),
				S3Uri: jsii.String("s3Uri"),
			},
		},
	},
	CustomPosixUserConfig: &CustomPosixUserConfigProperty{
		Gid: jsii.Number(123),
		Uid: jsii.Number(123),
	},
	DefaultLandingUri: jsii.String("defaultLandingUri"),
	ExecutionRole: jsii.String("executionRole"),
	JupyterLabAppSettings: &JupyterLabAppSettingsProperty{
		AppLifecycleManagement: &AppLifecycleManagementProperty{
			IdleSettings: &IdleSettingsProperty{
				IdleTimeoutInMinutes: jsii.Number(123),
				LifecycleManagement: jsii.String("lifecycleManagement"),
				MaxIdleTimeoutInMinutes: jsii.Number(123),
				MinIdleTimeoutInMinutes: jsii.Number(123),
			},
		},
		BuiltInLifecycleConfigArn: jsii.String("builtInLifecycleConfigArn"),
		CodeRepositories: []interface{}{
			&CodeRepositoryProperty{
				RepositoryUrl: jsii.String("repositoryUrl"),
			},
		},
		CustomImages: []interface{}{
			&CustomImageProperty{
				AppImageConfigName: jsii.String("appImageConfigName"),
				ImageName: jsii.String("imageName"),

				// the properties below are optional
				ImageVersionNumber: jsii.Number(123),
			},
		},
		DefaultResourceSpec: &ResourceSpecProperty{
			InstanceType: jsii.String("instanceType"),
			LifecycleConfigArn: jsii.String("lifecycleConfigArn"),
			SageMakerImageArn: jsii.String("sageMakerImageArn"),
			SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"),
			TrainingPlanArn: jsii.String("trainingPlanArn"),
		},
		EmrSettings: &EmrSettingsProperty{
			AssumableRoleArns: []*string{
				jsii.String("assumableRoleArns"),
			},
			ExecutionRoleArns: []*string{
				jsii.String("executionRoleArns"),
			},
		},
		LifecycleConfigArns: []*string{
			jsii.String("lifecycleConfigArns"),
		},
	},
	JupyterServerAppSettings: &JupyterServerAppSettingsProperty{
		DefaultResourceSpec: &ResourceSpecProperty{
			InstanceType: jsii.String("instanceType"),
			LifecycleConfigArn: jsii.String("lifecycleConfigArn"),
			SageMakerImageArn: jsii.String("sageMakerImageArn"),
			SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"),
			TrainingPlanArn: jsii.String("trainingPlanArn"),
		},
		LifecycleConfigArns: []*string{
			jsii.String("lifecycleConfigArns"),
		},
	},
	KernelGatewayAppSettings: &KernelGatewayAppSettingsProperty{
		CustomImages: []interface{}{
			&CustomImageProperty{
				AppImageConfigName: jsii.String("appImageConfigName"),
				ImageName: jsii.String("imageName"),

				// the properties below are optional
				ImageVersionNumber: jsii.Number(123),
			},
		},
		DefaultResourceSpec: &ResourceSpecProperty{
			InstanceType: jsii.String("instanceType"),
			LifecycleConfigArn: jsii.String("lifecycleConfigArn"),
			SageMakerImageArn: jsii.String("sageMakerImageArn"),
			SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"),
			TrainingPlanArn: jsii.String("trainingPlanArn"),
		},
		LifecycleConfigArns: []*string{
			jsii.String("lifecycleConfigArns"),
		},
	},
	RStudioServerProAppSettings: &RStudioServerProAppSettingsProperty{
		AccessStatus: jsii.String("accessStatus"),
		UserGroup: jsii.String("userGroup"),
	},
	SecurityGroups: []*string{
		jsii.String("securityGroups"),
	},
	SharingSettings: &SharingSettingsProperty{
		NotebookOutputOption: jsii.String("notebookOutputOption"),
		S3KmsKeyId: jsii.String("s3KmsKeyId"),
		S3OutputPath: jsii.String("s3OutputPath"),
	},
	SpaceStorageSettings: &DefaultSpaceStorageSettingsProperty{
		DefaultEbsStorageSettings: &DefaultEbsStorageSettingsProperty{
			DefaultEbsVolumeSizeInGb: jsii.Number(123),
			MaximumEbsVolumeSizeInGb: jsii.Number(123),
		},
	},
	StudioWebPortal: jsii.String("studioWebPortal"),
	StudioWebPortalSettings: &StudioWebPortalSettingsProperty{
		HiddenAppTypes: []*string{
			jsii.String("hiddenAppTypes"),
		},
		HiddenInstanceTypes: []*string{
			jsii.String("hiddenInstanceTypes"),
		},
		HiddenMlTools: []*string{
			jsii.String("hiddenMlTools"),
		},
		HiddenSageMakerImageVersionAliases: []interface{}{
			&HiddenSageMakerImageProperty{
				SageMakerImageName: jsii.String("sageMakerImageName"),
				VersionAliases: []*string{
					jsii.String("versionAliases"),
				},
			},
		},
	},
}

Properties ​

autoMountHomeEfsoptionalstringauto_mount_home_efsoptionalstrautoMountHomeEfsoptionalStringAutoMountHomeEfsoptionalstringAutoMountHomeEfsoptional*string #
Indicates whether auto-mounting of an EFS volume is supported for the user profile.
notes

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.

codeEditorAppSettingsoptionalIResolvable | CfnUserProfile.CodeEditorAppSettingsPropertycode_editor_app_settingsoptionaltyping.Union[IResolvable, CodeEditorAppSettingsProperty]codeEditorAppSettingsoptionalIResolvableCodeEditorAppSettingsoptionalIResolvableCodeEditorAppSettingsoptionalinterface{} #
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.

customFileSystemConfigsoptionalIResolvable | IResolvable | CfnUserProfile.CustomFileSystemConfigProperty[]custom_file_system_configsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, CustomFileSystemConfigProperty]]]customFileSystemConfigsoptionalIResolvableCustomFileSystemConfigsoptionalIResolvableCustomFileSystemConfigsoptionalinterface{} #
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.

customPosixUserConfigoptionalIResolvable | CfnUserProfile.CustomPosixUserConfigPropertycustom_posix_user_configoptionaltyping.Union[IResolvable, CustomPosixUserConfigProperty]customPosixUserConfigoptionalIResolvableCustomPosixUserConfigoptionalIResolvableCustomPosixUserConfigoptionalinterface{} #
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.

defaultLandingUrioptionalstringdefault_landing_urioptionalstrdefaultLandingUrioptionalStringDefaultLandingUrioptionalstringDefaultLandingUrioptional*string #
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.
executionRoleoptionalstringexecution_roleoptionalstrexecutionRoleoptionalStringExecutionRoleoptionalstringExecutionRoleoptional*string #
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.

jupyterLabAppSettingsoptionalIResolvable | CfnUserProfile.JupyterLabAppSettingsPropertyjupyter_lab_app_settingsoptionaltyping.Union[IResolvable, JupyterLabAppSettingsProperty]jupyterLabAppSettingsoptionalIResolvableJupyterLabAppSettingsoptionalIResolvableJupyterLabAppSettingsoptionalinterface{} #
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.

jupyterServerAppSettingsoptionalIResolvable | CfnUserProfile.JupyterServerAppSettingsPropertyjupyter_server_app_settingsoptionaltyping.Union[IResolvable, JupyterServerAppSettingsProperty]jupyterServerAppSettingsoptionalIResolvableJupyterServerAppSettingsoptionalIResolvableJupyterServerAppSettingsoptionalinterface{} #
The Jupyter server's app settings.
kernelGatewayAppSettingsoptionalIResolvable | CfnUserProfile.KernelGatewayAppSettingsPropertykernel_gateway_app_settingsoptionaltyping.Union[IResolvable, KernelGatewayAppSettingsProperty]kernelGatewayAppSettingsoptionalIResolvableKernelGatewayAppSettingsoptionalIResolvableKernelGatewayAppSettingsoptionalinterface{} #
The kernel gateway app settings.
rStudioServerProAppSettingsoptionalIResolvable | CfnUserProfile.RStudioServerProAppSettingsPropertyr_studio_server_pro_app_settingsoptionaltyping.Union[IResolvable, RStudioServerProAppSettingsProperty]rStudioServerProAppSettingsoptionalIResolvableRStudioServerProAppSettingsoptionalIResolvableRStudioServerProAppSettingsoptionalinterface{} #
A collection of settings that configure user interaction with the `RStudioServerPro` app.
securityGroupsoptionalstring[]security_groupsoptionaltyping.List[str]securityGroupsoptionalList<String>SecurityGroupsoptionalstring[]SecurityGroupsoptional*[]*string #
The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
notes

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.

sharingSettingsoptionalIResolvable | CfnUserProfile.SharingSettingsPropertysharing_settingsoptionaltyping.Union[IResolvable, SharingSettingsProperty]sharingSettingsoptionalIResolvableSharingSettingsoptionalIResolvableSharingSettingsoptionalinterface{} #
Specifies options for sharing Amazon SageMaker AI Studio notebooks.
spaceStorageSettingsoptionalIResolvable | CfnUserProfile.DefaultSpaceStorageSettingsPropertyspace_storage_settingsoptionaltyping.Union[IResolvable, DefaultSpaceStorageSettingsProperty]spaceStorageSettingsoptionalIResolvableSpaceStorageSettingsoptionalIResolvableSpaceStorageSettingsoptionalinterface{} #
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.

studioWebPortaloptionalstringstudio_web_portaloptionalstrstudioWebPortaloptionalStringStudioWebPortaloptionalstringStudioWebPortaloptional*string #
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.

studioWebPortalSettingsoptionalIResolvable | CfnUserProfile.StudioWebPortalSettingsPropertystudio_web_portal_settingsoptionaltyping.Union[IResolvable, StudioWebPortalSettingsProperty]studioWebPortalSettingsoptionalIResolvableStudioWebPortalSettingsoptionalIResolvableStudioWebPortalSettingsoptionalinterface{} #
Studio settings.

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