interface CfnUserProfileMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.SageMaker.Mixins.CfnUserProfileMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awssagemaker/mixins#CfnUserProfileMixinProps
Java	software.amazon.awscdk.mixins.preview.services.sagemaker.mixins.CfnUserProfileMixinProps
Python	aws_cdk.mixins_preview.aws_sagemaker.mixins.CfnUserProfileMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_sagemaker » mixins » CfnUserProfileMixinProps

Properties for CfnUserProfilePropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-userprofile.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as sagemaker_mixins } from '@aws-cdk/mixins-preview/aws-sagemaker';
const cfnUserProfileMixinProps: sagemaker_mixins.CfnUserProfileMixinProps = {
  domainId: 'domainId',
  singleSignOnUserIdentifier: 'singleSignOnUserIdentifier',
  singleSignOnUserValue: 'singleSignOnUserValue',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  userProfileName: 'userProfileName',
  userSettings: {
    autoMountHomeEfs: 'autoMountHomeEfs',
    codeEditorAppSettings: {
      appLifecycleManagement: {
        idleSettings: {
          idleTimeoutInMinutes: 123,
          lifecycleManagement: 'lifecycleManagement',
          maxIdleTimeoutInMinutes: 123,
          minIdleTimeoutInMinutes: 123,
        },
      },
      builtInLifecycleConfigArn: 'builtInLifecycleConfigArn',
      customImages: [{
        appImageConfigName: 'appImageConfigName',
        imageName: 'imageName',
        imageVersionNumber: 123,
      }],
      defaultResourceSpec: {
        instanceType: 'instanceType',
        lifecycleConfigArn: 'lifecycleConfigArn',
        sageMakerImageArn: 'sageMakerImageArn',
        sageMakerImageVersionArn: 'sageMakerImageVersionArn',
      },
      lifecycleConfigArns: ['lifecycleConfigArns'],
    },
    customFileSystemConfigs: [{
      efsFileSystemConfig: {
        fileSystemId: 'fileSystemId',
        fileSystemPath: 'fileSystemPath',
      },
      fSxLustreFileSystemConfig: {
        fileSystemId: 'fileSystemId',
        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',
        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',
        imageVersionNumber: 123,
      }],
      defaultResourceSpec: {
        instanceType: 'instanceType',
        lifecycleConfigArn: 'lifecycleConfigArn',
        sageMakerImageArn: 'sageMakerImageArn',
        sageMakerImageVersionArn: 'sageMakerImageVersionArn',
      },
      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

Name	Type	Description
domainId?	string	The domain ID.
singleSignOnUserIdentifier?	string	A specifier for the type of value specified in SingleSignOnUserValue.
singleSignOnUserValue?	string	The username of the associated AWS Single Sign-On User for this UserProfile.
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.
userProfileName?	string	The user profile name.
userSettings?	IResolvable | UserSettingsProperty	A collection of settings that apply to users of Amazon SageMaker Studio.

---

domainId?

Type: string (optional)

The domain ID.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-userprofile.html#cfn-sagemaker-userprofile-domainid

---

singleSignOnUserIdentifier?

Type: string (optional)

A specifier for the type of value specified in SingleSignOnUserValue.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-userprofile.html#cfn-sagemaker-userprofile-singlesignonuseridentifier

---

singleSignOnUserValue?

Type: string (optional)

The username of the associated AWS Single Sign-On User for this UserProfile.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-userprofile.html#cfn-sagemaker-userprofile-singlesignonuservalue

---

tags?

Type: CfnTag[] (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-userprofile.html#cfn-sagemaker-userprofile-tags

---

userProfileName?

Type: string (optional)

The user profile name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-userprofile.html#cfn-sagemaker-userprofile-userprofilename

---

userSettings?

Type: IResolvable | UserSettingsProperty (optional)

A collection of settings that apply to users of Amazon SageMaker Studio.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-userprofile.html#cfn-sagemaker-userprofile-usersettings