CfnUserProfileProps Struct
Properties for defining a CfnUserProfile.
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
domainIdstring | IDomainRefdomain_idtyping.Union[str, IDomainRef]domainIdStringDomainIdstringDomainIdinterface{}required#The domain ID.
singleSignOnUserIdentifieroptionalstringsingle_sign_on_user_identifieroptionalstrsingleSignOnUserIdentifieroptionalStringSingleSignOnUserIdentifieroptionalstringSingleSignOnUserIdentifieroptional*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.
singleSignOnUserValueoptionalstringsingle_sign_on_user_valueoptionalstrsingleSignOnUserValueoptionalStringSingleSignOnUserValueoptionalstringSingleSignOnUserValueoptional*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.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#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 .
userProfileNamestringuser_profile_namestruserProfileNameStringUserProfileNamestringUserProfileName*stringrequired#The user profile name.
userSettingsoptionalIResolvable | CfnUserProfile.UserSettingsPropertyuser_settingsoptionaltyping.Union[IResolvable, UserSettingsProperty]userSettingsoptionalIResolvableUserSettingsoptionalIResolvableUserSettingsoptionalinterface{}#A collection of settings that apply to users of Amazon SageMaker Studio.