Package com.pulumi.aws.connect

Class User

  • public class User
extends com.pulumi.resources.CustomResource
    Provides an Amazon Connect User resource. For more information see [Amazon Connect: Getting Started](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-get-started.html) ## Example Usage ### Basic <!--Start PulumiCodeChooser --> 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.connect.User;
 import com.pulumi.aws.connect.UserArgs;
 import com.pulumi.aws.connect.inputs.UserIdentityInfoArgs;
 import com.pulumi.aws.connect.inputs.UserPhoneConfigArgs;
 import java.util.List;
 import java.util.ArrayList;
 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()        
             .instanceId(exampleAwsConnectInstance.id())
             .name("example")
             .password("Password123")
             .routingProfileId(exampleAwsConnectRoutingProfile.routingProfileId())
             .securityProfileIds(exampleAwsConnectSecurityProfile.securityProfileId())
             .identityInfo(UserIdentityInfoArgs.builder()
                 .firstName("example")
                 .lastName("example2")
                 .build())
             .phoneConfig(UserPhoneConfigArgs.builder()
                 .afterContactWorkTimeLimit(0)
                 .phoneType("SOFT_PHONE")
                 .build())
             .build());
 
     }
 }
    <!--End PulumiCodeChooser --> ### With hierarchy_group_id <!--Start PulumiCodeChooser --> 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.connect.User;
 import com.pulumi.aws.connect.UserArgs;
 import com.pulumi.aws.connect.inputs.UserIdentityInfoArgs;
 import com.pulumi.aws.connect.inputs.UserPhoneConfigArgs;
 import java.util.List;
 import java.util.ArrayList;
 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()        
             .instanceId(exampleAwsConnectInstance.id())
             .name("example")
             .password("Password123")
             .routingProfileId(exampleAwsConnectRoutingProfile.routingProfileId())
             .hierarchyGroupId(exampleAwsConnectUserHierarchyGroup.hierarchyGroupId())
             .securityProfileIds(exampleAwsConnectSecurityProfile.securityProfileId())
             .identityInfo(UserIdentityInfoArgs.builder()
                 .firstName("example")
                 .lastName("example2")
                 .build())
             .phoneConfig(UserPhoneConfigArgs.builder()
                 .afterContactWorkTimeLimit(0)
                 .phoneType("SOFT_PHONE")
                 .build())
             .build());
 
     }
 }
    <!--End PulumiCodeChooser --> ### With identity_info filled <!--Start PulumiCodeChooser --> 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.connect.User;
 import com.pulumi.aws.connect.UserArgs;
 import com.pulumi.aws.connect.inputs.UserIdentityInfoArgs;
 import com.pulumi.aws.connect.inputs.UserPhoneConfigArgs;
 import java.util.List;
 import java.util.ArrayList;
 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()        
             .instanceId(exampleAwsConnectInstance.id())
             .name("example")
             .password("Password123")
             .routingProfileId(exampleAwsConnectRoutingProfile.routingProfileId())
             .securityProfileIds(exampleAwsConnectSecurityProfile.securityProfileId())
             .identityInfo(UserIdentityInfoArgs.builder()
                 .email("example{@literal @}example.com")
                 .firstName("example")
                 .lastName("example2")
                 .build())
             .phoneConfig(UserPhoneConfigArgs.builder()
                 .afterContactWorkTimeLimit(0)
                 .phoneType("SOFT_PHONE")
                 .build())
             .build());
 
     }
 }
    <!--End PulumiCodeChooser --> ### With phone_config phone type as desk phone <!--Start PulumiCodeChooser --> 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.connect.User;
 import com.pulumi.aws.connect.UserArgs;
 import com.pulumi.aws.connect.inputs.UserPhoneConfigArgs;
 import java.util.List;
 import java.util.ArrayList;
 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()        
             .instanceId(exampleAwsConnectInstance.id())
             .name("example")
             .password("Password123")
             .routingProfileId(exampleAwsConnectRoutingProfile.routingProfileId())
             .securityProfileIds(exampleAwsConnectSecurityProfile.securityProfileId())
             .phoneConfig(UserPhoneConfigArgs.builder()
                 .afterContactWorkTimeLimit(0)
                 .phoneType("SOFT_PHONE")
                 .build())
             .build());
 
     }
 }
    <!--End PulumiCodeChooser --> ### With multiple Security profile ids specified in security_profile_ids <!--Start PulumiCodeChooser --> 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.connect.User;
 import com.pulumi.aws.connect.UserArgs;
 import com.pulumi.aws.connect.inputs.UserPhoneConfigArgs;
 import java.util.List;
 import java.util.ArrayList;
 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()        
             .instanceId(exampleAwsConnectInstance.id())
             .name("example")
             .password("Password123")
             .routingProfileId(exampleAwsConnectRoutingProfile.routingProfileId())
             .securityProfileIds(            
                 exampleAwsConnectSecurityProfile.securityProfileId(),
                 example2.securityProfileId())
             .phoneConfig(UserPhoneConfigArgs.builder()
                 .afterContactWorkTimeLimit(0)
                 .autoAccept(false)
                 .deskPhoneNumber("+112345678912")
                 .phoneType("DESK_PHONE")
                 .build())
             .build());
 
     }
 }
    <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import Amazon Connect Users using the `instance_id` and `user_id` separated by a colon (`:`). For example: ```sh $ pulumi import aws:connect/user:User example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ```

    • 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.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> directoryUserId()  
      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.util.Optional<java.lang.String>> hierarchyGroupId()  
      com.pulumi.core.Output<java.util.Optional<UserIdentityInfo>> identityInfo()  
      com.pulumi.core.Output<java.lang.String> instanceId()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> password()  
      com.pulumi.core.Output<UserPhoneConfig> phoneConfig()  
      com.pulumi.core.Output<java.lang.String> routingProfileId()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> securityProfileIds()  
      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> userId()  

      • 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

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        The Amazon Resource Name (ARN) of the user.

      • directoryUserId

        public com.pulumi.core.Output<java.lang.String> directoryUserId()
        Returns:
        The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory. This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

      • hierarchyGroupId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> hierarchyGroupId()
        Returns:
        The identifier of the hierarchy group for the user.

      • identityInfo

        public com.pulumi.core.Output<java.util.Optional<UserIdentityInfo>> identityInfo()
        Returns:
        A block that contains information about the identity of the user. Documented below.

      • instanceId

        public com.pulumi.core.Output<java.lang.String> instanceId()
        Returns:
        Specifies the identifier of the hosting Amazon Connect Instance.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from `[a-zA-Z0-9_-.\@]+`.

      • password

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> password()
        Returns:
        The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

      • phoneConfig

        public com.pulumi.core.Output<UserPhoneConfig> phoneConfig()
        Returns:
        A block that contains information about the phone settings for the user. Documented below.

      • routingProfileId

        public com.pulumi.core.Output<java.lang.String> routingProfileId()
        Returns:
        The identifier of the routing profile for the user.

      • securityProfileIds

        public com.pulumi.core.Output<java.util.List<java.lang.String>> securityProfileIds()
        Returns:
        A list of identifiers for the security profiles for the user. Specify a minimum of 1 and maximum of 10 security profile ids. For more information, see [Best Practices for Security Profiles](https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html) in the Amazon Connect Administrator Guide.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Tags to apply to the user. If configured with a provider `default_tags` 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 `default_tags` configuration block.

      • userId

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

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