AWS::SageMaker::UserProfile - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::SageMaker::UserProfile

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.

Note

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 Amazon CloudFormation.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SageMaker::UserProfile",
  "Properties" : {
      "DomainId" : String,
      "SingleSignOnUserIdentifier" : String,
      "SingleSignOnUserValue" : String,
      "Tags" : [ Tag, ... ],
      "UserProfileName" : String,
      "UserSettings" : UserSettings
    }
}

YAML

Type: AWS::SageMaker::UserProfile
Properties:
  DomainId: String
  SingleSignOnUserIdentifier: String
  SingleSignOnUserValue: String
  Tags: 
    - Tag
  UserProfileName: String
  UserSettings: 
    UserSettings

Properties

DomainId

The domain ID.

Required: Yes

Type: String

Minimum: 1

Maximum: 63

Update requires: Replacement

SingleSignOnUserIdentifier

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.

Required: No

Type: String

Pattern: UserName

Update requires: Replacement

SingleSignOnUserValue

The username of the associated Amazon 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.

Required: No

Type: String

Minimum: 1

Maximum: 256

Update requires: Replacement

Tags

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.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: Replacement

UserProfileName

The user profile name.

Required: Yes

Type: String

Minimum: 1

Maximum: 63

Update requires: Replacement

UserSettings

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

Required: No

Type: UserSettings

Minimum: 0

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Domain ID and the user profile name, such as d-xxxxxxxxxxxx and my-user-profile, respectively.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

UserProfileArn

The Amazon Resource Name (ARN) of the user profile, such as arn:aws:sagemaker:region:account-id:user-profile/domain-id/user-profile-name.