Package software.amazon.awscdk.services.sagemaker

Class CfnUserProfile

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.sagemaker.CfnUserProfile
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.541Z") @Stability(Stable) public class CfnUserProfile extends CfnResource implements IInspectable
A CloudFormation 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.

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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 CfnUserProfile cfnUserProfile = CfnUserProfile.Builder.create(this, "MyCfnUserProfile")
         .domainId("domainId")
         .userProfileName("userProfileName")
         // the properties below are optional
         .singleSignOnUserIdentifier("singleSignOnUserIdentifier")
         .singleSignOnUserValue("singleSignOnUserValue")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userSettings(UserSettingsProperty.builder()
                 .executionRole("executionRole")
                 .jupyterServerAppSettings(JupyterServerAppSettingsProperty.builder()
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .build())
                 .kernelGatewayAppSettings(KernelGatewayAppSettingsProperty.builder()
                         .customImages(List.of(CustomImageProperty.builder()
                                 .appImageConfigName("appImageConfigName")
                                 .imageName("imageName")
                                 // the properties below are optional
                                 .imageVersionNumber(123)
                                 .build()))
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .build())
                 .rStudioServerProAppSettings(RStudioServerProAppSettingsProperty.builder()
                         .accessStatus("accessStatus")
                         .userGroup("userGroup")
                         .build())
                 .securityGroups(List.of("securityGroups"))
                 .sharingSettings(SharingSettingsProperty.builder()
                         .notebookOutputOption("notebookOutputOption")
                         .s3KmsKeyId("s3KmsKeyId")
                         .s3OutputPath("s3OutputPath")
                         .build())
                 .build())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnUserProfile

      protected CfnUserProfile(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnUserProfile

      protected CfnUserProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnUserProfile

      @Stability(Stable) public CfnUserProfile(@NotNull Construct scope, @NotNull String id, @NotNull CfnUserProfileProps props)
      Create a new AWS::SageMaker::UserProfile.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrUserProfileArn

      @Stability(Stable) @NotNull public String getAttrUserProfileArn()
      The Amazon Resource Name (ARN) of the user profile, such as arn:aws:sagemaker:us-west-2:account-id:user-profile/my-user-profile .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      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 .

    • getDomainId

      @Stability(Stable) @NotNull public String getDomainId()
      The domain ID.

    • setDomainId

      @Stability(Stable) public void setDomainId(@NotNull String value)
      The domain ID.

    • getUserProfileName

      @Stability(Stable) @NotNull public String getUserProfileName()
      The user profile name.

    • setUserProfileName

      @Stability(Stable) public void setUserProfileName(@NotNull String value)
      The user profile name.

    • getSingleSignOnUserIdentifier

      @Stability(Stable) @Nullable public String getSingleSignOnUserIdentifier()
      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.

    • setSingleSignOnUserIdentifier

      @Stability(Stable) public void setSingleSignOnUserIdentifier(@Nullable String value)
      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.

    • getSingleSignOnUserValue

      @Stability(Stable) @Nullable public String getSingleSignOnUserValue()
      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.

    • setSingleSignOnUserValue

      @Stability(Stable) public void setSingleSignOnUserValue(@Nullable String value)
      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.

    • getUserSettings

      @Stability(Stable) @Nullable public Object getUserSettings()
      A collection of settings that apply to users of Amazon SageMaker Studio.

    • setUserSettings

      @Stability(Stable) public void setUserSettings(@Nullable IResolvable value)
      A collection of settings that apply to users of Amazon SageMaker Studio.

    • setUserSettings

      @Stability(Stable) public void setUserSettings(@Nullable CfnUserProfile.UserSettingsProperty value)
      A collection of settings that apply to users of Amazon SageMaker Studio.