aws-cdk-lib.aws_sagemaker.CfnUserProfileProps

interface CfnUserProfileProps

LanguageType name
.NETAmazon.CDK.AWS.Sagemaker.CfnUserProfileProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnUserProfileProps
Javasoftware.amazon.awscdk.services.sagemaker.CfnUserProfileProps
Pythonaws_cdk.aws_sagemaker.CfnUserProfileProps
TypeScript aws-cdk-lib » aws_sagemaker » CfnUserProfileProps

Properties for defining a CfnUserProfile.

Example

// 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: {
    executionRole: 'executionRole',
    jupyterServerAppSettings: {
      defaultResourceSpec: {
        instanceType: 'instanceType',
        sageMakerImageArn: 'sageMakerImageArn',
        sageMakerImageVersionArn: 'sageMakerImageVersionArn',
      },
    },
    kernelGatewayAppSettings: {
      customImages: [{
        appImageConfigName: 'appImageConfigName',
        imageName: 'imageName',

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

Properties

NameTypeDescription
domainIdstringThe domain ID.
userProfileNamestringThe user profile name.
singleSignOnUserIdentifier?stringA specifier for the type of value specified in SingleSignOnUserValue.
singleSignOnUserValue?stringThe 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.
userSettings?IResolvable | UserSettingsPropertyA collection of settings that apply to users of Amazon SageMaker Studio.

domainId

Type: string

The domain ID.


userProfileName

Type: string

The user profile name.


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.


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.


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 .


userSettings?

Type: IResolvable | UserSettingsProperty (optional)

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