Package com.pulumi.aws.sagemaker

Class UserProfile

  • public class UserProfile
extends com.pulumi.resources.CustomResource
    Provides a SageMaker AI User Profile resource. ## Example Usage ### Basic usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.sagemaker.UserProfile;
 import com.pulumi.aws.sagemaker.UserProfileArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new UserProfile("example", UserProfileArgs.builder()
             .domainId(test.id())
             .userProfileName("example")
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `domainId` (String) SageMaker domain ID. * `userProfileName` (String) Name of the user profile. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import SageMaker AI User Profiles using the `arn`. For example: ```sh $ pulumi import aws:sagemaker/userProfile:UserProfile example arn:aws:sagemaker:us-west-2:123456789012:user-profile/domain-id/profile-name ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> domainId()  
      static UserProfile get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, UserProfileState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> homeEfsFileSystemUid()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> singleSignOnUserIdentifier()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> singleSignOnUserValue()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> userProfileName()  
      com.pulumi.core.Output<java.util.Optional<UserProfileUserSettings>> userSettings()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • UserProfile

        public UserProfile​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • UserProfile

        public UserProfile​(java.lang.String name,
                   UserProfileArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • UserProfile

        public UserProfile​(java.lang.String name,
                   UserProfileArgs args,
                   @Nullable
                   com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        User profile ARN.

      • domainId

        public com.pulumi.core.Output<java.lang.String> domainId()
        Returns:
        The ID of the associated Domain.

      • homeEfsFileSystemUid

        public com.pulumi.core.Output<java.lang.String> homeEfsFileSystemUid()
        Returns:
        The ID of the user's profile in the Amazon Elastic File System (EFS) volume.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • singleSignOnUserIdentifier

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> singleSignOnUserIdentifier()
        Returns:
        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

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> singleSignOnUserValue()
        Returns:
        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.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • userProfileName

        public com.pulumi.core.Output<java.lang.String> userProfileName()
        Returns:
        The name for the User Profile.

      • userSettings

        public com.pulumi.core.Output<java.util.Optional<UserProfileUserSettings>> userSettings()
        Returns:
        The user settings. See User Settings below.

      • get

        public static UserProfile get​(java.lang.String name,
                              com.pulumi.core.Output<java.lang.String> id,
                              @Nullable
                              UserProfileState state,
                              @Nullable
                              com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.