aws-cdk-lib.aws_sagemaker.CfnDomain.DefaultSpaceSettingsProperty

DefaultSpaceSettingsProperty Struct

The default settings for shared spaces that users create in the domain.

SageMaker applies these settings only to shared spaces. It doesn't apply them to private spaces.

Source

Generated code

Type last changed

v2.143.0 · 24 May 2024

Example

// 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 defaultSpaceSettingsProperty: sagemaker.CfnDomain.DefaultSpaceSettingsProperty = {
  executionRole: 'executionRole',

  // the properties below are optional
  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,
  },
  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',
    },
    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'],
  },
  securityGroups: ['securityGroups'],
  spaceStorageSettings: {
    defaultEbsStorageSettings: {
      defaultEbsVolumeSizeInGb: 123,
      maximumEbsVolumeSizeInGb: 123,
    },
  },
};

Properties

customFileSystemConfigsIResolvable | IResolvable | CfnDomain.CustomFileSystemConfigProperty[]custom_file_system_configstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, CustomFileSystemConfigProperty]]]customFileSystemConfigsIResolvableCustomFileSystemConfigsIResolvableCustomFileSystemConfigsinterface{}#

The settings for assigning a custom file system to a domain.

Permitted users can access this file system in Amazon SageMaker AI Studio.

customPosixUserConfigIResolvable | CfnDomain.CustomPosixUserConfigPropertycustom_posix_user_configtyping.Union[IResolvable, CustomPosixUserConfigProperty]customPosixUserConfigIResolvableCustomPosixUserConfigIResolvableCustomPosixUserConfiginterface{}#

executionRolestringexecution_rolestrexecutionRoleStringExecutionRolestringExecutionRole*stringrequired#

The ARN of the execution role for the space.

jupyterLabAppSettingsIResolvable | CfnDomain.JupyterLabAppSettingsPropertyjupyter_lab_app_settingstyping.Union[IResolvable, JupyterLabAppSettingsProperty]jupyterLabAppSettingsIResolvableJupyterLabAppSettingsIResolvableJupyterLabAppSettingsinterface{}#

The JupyterLab app settings.

jupyterServerAppSettingsIResolvable | CfnDomain.JupyterServerAppSettingsPropertyjupyter_server_app_settingstyping.Union[IResolvable, JupyterServerAppSettingsProperty]jupyterServerAppSettingsIResolvableJupyterServerAppSettingsIResolvableJupyterServerAppSettingsinterface{}#

The JupyterServer app settings.

kernelGatewayAppSettingsIResolvable | CfnDomain.KernelGatewayAppSettingsPropertykernel_gateway_app_settingstyping.Union[IResolvable, KernelGatewayAppSettingsProperty]kernelGatewayAppSettingsIResolvableKernelGatewayAppSettingsIResolvableKernelGatewayAppSettingsinterface{}#

The KernelGateway app settings.

securityGroupsstring[]security_groupstyping.List[str]securityGroupsList<String>SecurityGroupsstring[]SecurityGroups*[]*string#

The security group IDs for the Amazon VPC that the space uses for communication.

spaceStorageSettingsIResolvable | CfnDomain.DefaultSpaceStorageSettingsPropertyspace_storage_settingstyping.Union[IResolvable, DefaultSpaceStorageSettingsProperty]spaceStorageSettingsIResolvableSpaceStorageSettingsIResolvableSpaceStorageSettingsinterface{}#

Default storage settings for a space.