# CfnUserProfileProps

Properties for defining a `CfnUserProfile`.

Extends: CfnUserProfileProps
Used as props by: CfnUserProfile

- Source: Generated code
- Type last changed: v2.227.0 · 21 Nov 2025

## 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 cfnUserProfileProps: sagemaker.CfnUserProfileProps = {
  domainId: 'domainId',
  userProfileName: 'userProfileName',

  // the properties below are optional
  singleSignOnUserIdentifier: 'singleSignOnUserIdentifier',
  singleSignOnUserValue: 'singleSignOnUserValue',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  userSettings: {
    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'],
      }],
    },
  },
};
```

## Properties

- `domainId`: string | [IDomainRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_sagemaker.IDomainRef.html) (required) — The domain ID.

- `singleSignOnUserIdentifier`: string — A specifier for the type of value specified in SingleSignOnUserValue.

  Currently, the only supported value is "UserName". If the Domain's AuthMode is SSO , this field is required. If the Domain's AuthMode is not SSO , this field cannot be specified.

- `singleSignOnUserValue`: string — The username of the associated AWS Single Sign-On User for this UserProfile.

  If the Domain's AuthMode is SSO , this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO , this field cannot be specified.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — An array of key-value pairs to apply to this resource.

  Tags that you specify for the User Profile are also added to all apps that the User Profile launches.

  For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

- `userProfileName`: string (required) — The user profile name.

- `userSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserProfile.UserSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnUserProfile.UserSettingsProperty.html) — A collection of settings that apply to users of Amazon SageMaker Studio.