interface UserSettingsProperty

Language	Type name
.NET	Amazon.CDK.AWS.Sagemaker.CfnDomain.UserSettingsProperty
Java	software.amazon.awscdk.services.sagemaker.CfnDomain.UserSettingsProperty
Python	aws_cdk.aws_sagemaker.CfnDomain.UserSettingsProperty
TypeScript	@aws-cdk/aws-sagemaker » CfnDomain » UserSettingsProperty

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

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as sagemaker from '@aws-cdk/aws-sagemaker';
const userSettingsProperty: sagemaker.CfnDomain.UserSettingsProperty = {
  executionRole: 'executionRole',

  // the properties below are optional
  jupyterServerAppSettings: {
    defaultResourceSpec: {
      instanceType: 'instanceType',
      lifecycleConfigArn: 'lifecycleConfigArn',
      sageMakerImageArn: 'sageMakerImageArn',
      sageMakerImageVersionArn: 'sageMakerImageVersionArn',
    },
  },
  kernelGatewayAppSettings: {
    customImages: [{
      appImageConfigName: 'appImageConfigName',
      imageName: 'imageName',

      // the properties below are optional
      imageVersionNumber: 123,
    }],
    defaultResourceSpec: {
      instanceType: 'instanceType',
      lifecycleConfigArn: 'lifecycleConfigArn',
      sageMakerImageArn: 'sageMakerImageArn',
      sageMakerImageVersionArn: 'sageMakerImageVersionArn',
    },
  },
  rSessionAppSettings: {
    customImages: [{
      appImageConfigName: 'appImageConfigName',
      imageName: 'imageName',

      // the properties below are optional
      imageVersionNumber: 123,
    }],
    defaultResourceSpec: {
      instanceType: 'instanceType',
      lifecycleConfigArn: 'lifecycleConfigArn',
      sageMakerImageArn: 'sageMakerImageArn',
      sageMakerImageVersionArn: 'sageMakerImageVersionArn',
    },
  },
  rStudioServerProAppSettings: {
    accessStatus: 'accessStatus',
    userGroup: 'userGroup',
  },
  securityGroups: ['securityGroups'],
  sharingSettings: {
    notebookOutputOption: 'notebookOutputOption',
    s3KmsKeyId: 's3KmsKeyId',
    s3OutputPath: 's3OutputPath',
  },
};

Properties

Name	Type	Description
executionRole	string	The execution role for the user.
jupyterServerAppSettings?	IResolvable | JupyterServerAppSettingsProperty	The Jupyter server's app settings.
kernelGatewayAppSettings?	IResolvable | KernelGatewayAppSettingsProperty	The kernel gateway app settings.
rSessionAppSettings?	IResolvable | RSessionAppSettingsProperty	A collection of settings that configure the RSessionGateway app.
rStudioServerProAppSettings?	IResolvable | RStudioServerProAppSettingsProperty	A collection of settings that configure user interaction with the RStudioServerPro app.
securityGroups?	string[]	The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
sharingSettings?	IResolvable | SharingSettingsProperty	Specifies options for sharing SageMaker Studio notebooks.

---

executionRole

Type: string

The execution role for the user.

---

jupyterServerAppSettings?

Type: IResolvable | JupyterServerAppSettingsProperty (optional)

The Jupyter server's app settings.

---

kernelGatewayAppSettings?

Type: IResolvable | KernelGatewayAppSettingsProperty (optional)

The kernel gateway app settings.

---

rSessionAppSettings?

Type: IResolvable | RSessionAppSettingsProperty (optional)

A collection of settings that configure the RSessionGateway app.

---

rStudioServerProAppSettings?

Type: IResolvable | RStudioServerProAppSettingsProperty (optional)

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

---

securityGroups?

Type: string[] (optional)

The security groups for the Amazon Virtual Private Cloud (VPC) that Studio 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 adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

---

sharingSettings?

Type: IResolvable | SharingSettingsProperty (optional)

Specifies options for sharing SageMaker Studio notebooks.