interface DefaultSpaceSettingsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Sagemaker.CfnDomain.DefaultSpaceSettingsProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnDomain_DefaultSpaceSettingsProperty`
Java	`software.amazon.awscdk.services.sagemaker.CfnDomain.DefaultSpaceSettingsProperty`
Python	`aws_cdk.aws_sagemaker.CfnDomain.DefaultSpaceSettingsProperty`
TypeScript	`aws-cdk-lib` » `aws_sagemaker` » `CfnDomain` » `DefaultSpaceSettingsProperty`

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.

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',
    },
    lifecycleConfigArns: ['lifecycleConfigArns'],
  },
  jupyterServerAppSettings: {
    defaultResourceSpec: {
      instanceType: 'instanceType',
      lifecycleConfigArn: 'lifecycleConfigArn',
      sageMakerImageArn: 'sageMakerImageArn',
      sageMakerImageVersionArn: 'sageMakerImageVersionArn',
    },
    lifecycleConfigArns: ['lifecycleConfigArns'],
  },
  kernelGatewayAppSettings: {
    customImages: [{
      appImageConfigName: 'appImageConfigName',
      imageName: 'imageName',

      // the properties below are optional
      imageVersionNumber: 123,
    }],
    defaultResourceSpec: {
      instanceType: 'instanceType',
      lifecycleConfigArn: 'lifecycleConfigArn',
      sageMakerImageArn: 'sageMakerImageArn',
      sageMakerImageVersionArn: 'sageMakerImageVersionArn',
    },
    lifecycleConfigArns: ['lifecycleConfigArns'],
  },
  securityGroups: ['securityGroups'],
  spaceStorageSettings: {
    defaultEbsStorageSettings: {
      defaultEbsVolumeSizeInGb: 123,
      maximumEbsVolumeSizeInGb: 123,
    },
  },
};

Properties

Name	Type	Description
executionRole	`string`	The ARN of the execution role for the space.
customFileSystemConfigs?	`IResolvable` `\| (IResolvable` `\|` `CustomFileSystemConfigProperty)[]`	The settings for assigning a custom file system to a domain.
customPosixUserConfig?	`IResolvable` `\|` `CustomPosixUserConfigProperty`
jupyterLabAppSettings?	`IResolvable` `\|` `JupyterLabAppSettingsProperty`	The JupyterLab app settings.
jupyterServerAppSettings?	`IResolvable` `\|` `JupyterServerAppSettingsProperty`	The JupyterServer app settings.
kernelGatewayAppSettings?	`IResolvable` `\|` `KernelGatewayAppSettingsProperty`	The KernelGateway app settings.
securityGroups?	`string[]`	The security group IDs for the Amazon VPC that the space uses for communication.
spaceStorageSettings?	`IResolvable` `\|` `DefaultSpaceStorageSettingsProperty`	Default storage settings for a space.