Skip to content

Resource: awsSagemakerUserProfile

Provides a SageMaker User Profile resource.

Example Usage

Basic usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.sagemakerUserProfile.SagemakerUserProfile(this, "example", {
  domainId: "${aws_sagemaker_domain.test.id}",
  userProfileName: "example",
});

Argument Reference

The following arguments are supported:

  • userProfileName - (Required) The name for the User Profile.
  • domainId - (Required) The ID of the associated Domain.
  • singleSignOnUserIdentifier - (Optional) 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.
  • singleSignOnUserValue - (Required) The username of the associated AWS Single Sign-On User for this User Profile. 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.
  • userSettings - (Required) The user settings. See User Settings below.
  • tags - (Optional) A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

User Settings

  • executionRole - (Required) The execution role ARN for the user.
  • securityGroups - (Optional) The security groups.
  • sharingSettings - (Optional) The sharing settings. See Sharing Settings below.
  • tensorBoardAppSettings - (Optional) The TensorBoard app settings. See TensorBoard App Settings below.
  • jupyterServerAppSettings - (Optional) The Jupyter server's app settings. See Jupyter Server App Settings below.
  • kernelGatewayAppSettings - (Optional) The kernel gateway app settings. See Kernel Gateway App Settings below.
  • rSessionAppSettings - (Optional) The RSession app settings. See RSession App Settings below.
  • canvasAppSettings - (Optional) The Canvas app settings. See Canvas App Settings below.

Canvas App Settings

Sharing Settings

  • notebookOutputOption - (Optional) Whether to include the notebook cell output when sharing the notebook. The default is disabled. Valid values are allowed and disabled.
  • s3KmsKeyId - (Optional) When notebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
  • s3OutputPath - (Optional) When notebookOutputOption is Allowed, the Amazon S3 bucket used to save the notebook cell output.

TensorBoard App Settings

  • defaultResourceSpec - (Optional) The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.

Kernel Gateway App Settings

  • defaultResourceSpec - (Optional) The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
  • customImage - (Optional) A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
  • lifecycleConfigArns - (Optional) The Amazon Resource Name (ARN) of the Lifecycle Configurations.

Jupyter Server App Settings

  • codeRepository - (Optional) A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application. see Code Repository below.
  • defaultResourceSpec - (Optional) The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
  • lifecycleConfigArns - (Optional) The Amazon Resource Name (ARN) of the Lifecycle Configurations.

RSession App Settings

  • defaultResourceSpec - (Optional) The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
  • customImage - (Optional) A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
Code Repository
  • repositoryUrl - (Optional) The URL of the Git repository.
Default Resource Spec
  • instanceType - (Optional) The instance type.
  • lifecycleConfigArn - (Optional) The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
  • sagemakerImageArn - (Optional) The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
  • sagemakerImageVersionArn - (Optional) The ARN of the image version created on the instance.
Custom Image
  • appImageConfigName - (Required) The name of the App Image Config.
  • imageName - (Required) The name of the Custom Image.
  • imageVersionNumber - (Optional) The version number of the Custom Image.
Time Series Forecasting Settings
  • amazonForecastRoleArn - (Optional) The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas app. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.
  • status - (Optional) Describes whether time series forecasting is enabled or disabled in the Canvas app. Valid values are enabled and disabled.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • id - The user profile Amazon Resource Name (ARN).
  • arn - The user profile Amazon Resource Name (ARN).
  • homeEfsFileSystemUid - The ID of the user's profile in the Amazon Elastic File System (EFS) volume.
  • tagsAll - A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

Import

SageMaker User Profiles can be imported using the arn, e.g.,

$ terraform import aws_sagemaker_user_profile.test_user_profile arn:aws:sagemaker:us-west-2:123456789012:user-profile/domain-id/profile-name