class CfnUserProfilePropsMixin

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

Implements IMixin

Extends Mixin

Creates a user profile.

A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from IAM Identity Center , a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.

If you're using IAM Identity Center authentication, a user in IAM Identity Center , or a group in IAM Identity Center containing that user, must be assigned to the Amazon SageMaker Studio application from the IAM Identity Center Console to create a user profile. For more information about application assignment, see Assign user access . After assignment is complete, a user profile can be created for that user in IAM Identity Center with AWS CloudFormation.

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 } from '@aws-cdk/mixins-preview';
import { mixins as sagemaker_mixins } from '@aws-cdk/mixins-preview/aws-sagemaker';
const cfnUserProfilePropsMixin = new sagemaker_mixins.CfnUserProfilePropsMixin({
  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'],
      }],
    },
  },
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnUserProfilePropsMixin(props: CfnUserProfileMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnUserProfileMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::SageMaker::UserProfile.

Properties

Name	Type	Description
props	CfnUserProfileMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnUserProfileMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.