Package com.pulumi.aws.connect.inputs

Class UserState

  • public final class UserState
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  UserState.Builder  

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

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static UserState Empty  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()  
      static UserState.Builder builder()  
      static UserState.Builder builder​(UserState defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> directoryUserId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> hierarchyGroupId()  
      java.util.Optional<com.pulumi.core.Output<UserIdentityInfoArgs>> identityInfo()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> instanceId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> password()  
      java.util.Optional<com.pulumi.core.Output<UserPhoneConfigArgs>> phoneConfig()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> routingProfileId()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> securityProfileIds()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> userId()  

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

        validateMember

      • Methods inherited from class java.lang.Object

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

    • Field Detail

    • Method Detail

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN of the user.

      • directoryUserId

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

      • identityInfo

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

      • instanceId

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

      • name

        public java.util.Optional<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 java.util.Optional<com.pulumi.core.Output<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 java.util.Optional<com.pulumi.core.Output<UserPhoneConfigArgs>> phoneConfig()
        Returns:
        A block that contains information about the phone settings for the user. Documented below.

      • region

        public java.util.Optional<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.

      • routingProfileId

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

      • securityProfileIds

        public java.util.Optional<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 java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Tags to apply to the user. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public java.util.Optional<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.

      • userId

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