Package com.pulumi.aws.identitystore

Class User

  • public class User
extends com.pulumi.resources.CustomResource
    This resource manages a User resource within an Identity Store. > **Note:** If you use an external identity provider or Active Directory as your identity source, use this resource with caution. IAM Identity Center does not support outbound synchronization, so your identity source does not automatically update with the changes that you make to users using this 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.identitystore.User;
 import com.pulumi.aws.identitystore.UserArgs;
 import com.pulumi.aws.identitystore.inputs.UserNameArgs;
 import com.pulumi.aws.identitystore.inputs.UserEmailsArgs;
 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 User("example", UserArgs.builder()
             .name(UserNameArgs.builder()
                 .givenName("John")
                 .familyName("Doe")
                 .build())
             .emails(UserEmailsArgs.builder()
                 .value("john@example.com")
                 .build())
             .identityStoreId(exampleAwsSsoadminInstances.identityStoreIds()[0])
             .displayName("John Doe")
             .userName("johndoe")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import an Identity Store User using the combination `identity_store_id/user_id`. For example: ```sh $ pulumi import aws:identitystore/user:User example d-9c6705e95c/065212b4-9061-703b-5876-13a517ae2a7c ```

    • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      User​(java.lang.String name)  
      User​(java.lang.String name, UserArgs args)  
      User​(java.lang.String name, UserArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<UserAddresses>> addresses()  
      com.pulumi.core.Output<java.lang.String> displayName()  
      com.pulumi.core.Output<java.util.Optional<UserEmails>> emails()  
      com.pulumi.core.Output<java.util.List<UserExternalId>> externalIds()  
      static User get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, UserState 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> identityStoreId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> locale()  
      com.pulumi.core.Output<UserName> name()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> nickname()  
      com.pulumi.core.Output<java.util.Optional<UserPhoneNumbers>> phoneNumbers()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> preferredLanguage()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> profileUrl()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> timezone()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> title()  
      com.pulumi.core.Output<java.lang.String> userId()  
      com.pulumi.core.Output<java.lang.String> userName()  
      com.pulumi.core.Output<java.lang.String> userStatus()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> userType()  

      • 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

      • User

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

      • User

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

      • User

        public User​(java.lang.String name,
            UserArgs 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

      • addresses

        public com.pulumi.core.Output<java.util.Optional<UserAddresses>> addresses()
        Returns:
        Details about the user's address. At most 1 address is allowed. Detailed below.

      • displayName

        public com.pulumi.core.Output<java.lang.String> displayName()
        Returns:
        The name that is typically displayed when the user is referenced.

      • emails

        public com.pulumi.core.Output<java.util.Optional<UserEmails>> emails()
        Returns:
        Details about the user's email. At most 1 email is allowed. Detailed below.

      • externalIds

        public com.pulumi.core.Output<java.util.List<UserExternalId>> externalIds()
        Returns:
        A list of identifiers issued to this resource by an external identity provider.

      • identityStoreId

        public com.pulumi.core.Output<java.lang.String> identityStoreId()
        Returns:
        The globally unique identifier for the identity store that this user is in.

      • locale

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> locale()
        Returns:
        The user's geographical region or location.

      • name

        public com.pulumi.core.Output<UserName> name()
        Returns:
        Details about the user's full name. Detailed below.

      • nickname

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> nickname()
        Returns:
        An alternate name for the user.

      • phoneNumbers

        public com.pulumi.core.Output<java.util.Optional<UserPhoneNumbers>> phoneNumbers()
        Returns:
        Details about the user's phone number. At most 1 phone number is allowed. Detailed below.

      • preferredLanguage

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> preferredLanguage()
        Returns:
        The preferred language of the user.

      • profileUrl

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> profileUrl()
        Returns:
        An URL that may be associated with the user.

      • 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.

      • timezone

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> timezone()
        Returns:
        The user's time zone.

      • title

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> title()
        Returns:
        The user's title.

      • userId

        public com.pulumi.core.Output<java.lang.String> userId()
        Returns:
        The identifier for this user in the identity store.

      • userName

        public com.pulumi.core.Output<java.lang.String> userName()
        Returns:
        A unique string used to identify the user. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store. The limit is 128 characters. The following arguments are optional:

      • userStatus

        public com.pulumi.core.Output<java.lang.String> userStatus()
        Returns:
        The current status of the user account.

      • userType

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> userType()
        Returns:
        The user type. > Unless specified otherwise, all fields can contain up to 1024 characters of free-form text.

      • get

        public static User get​(java.lang.String name,
                       com.pulumi.core.Output<java.lang.String> id,
                       @Nullable
                       UserState 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.