Package com.pulumi.aws.quicksight.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()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> awsAccountId()  
      static UserState.Builder builder()  
      static UserState.Builder builder​(UserState defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> email()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> iamArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> identityType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> namespace()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> sessionName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> userInvitationUrl()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> userName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> userRole()  

      • 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 for the user.

      • awsAccountId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> awsAccountId()
        Returns:
        AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.

      • email

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> email()
        Returns:
        Email address of the user that you want to register.

      • iamArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> iamArn()
        Returns:
        ARN of the IAM user or role that you are registering with Amazon QuickSight. Required only for users with an identity type of `IAM`.

      • identityType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> identityType()
        Returns:
        Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: `IAM`, `QUICKSIGHT`, `IAM_IDENTITY_CENTER`.

      • namespace

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> namespace()
        Returns:
        Amazon QuickSight namespace to create the user in. Defaults to `default`.

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

      • sessionName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> sessionName()
        Returns:
        Name of the IAM session to use when assuming roles that can embed QuickSight dashboards. Only valid for registering users using an assumed IAM role. Additionally, if registering multiple users using the same IAM role, each user needs to have a unique session name.

      • userInvitationUrl

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> userInvitationUrl()
        Returns:
        URL the user visits to complete registration and provide a password. Returned only for users with an identity type of `QUICKSIGHT`.

      • userName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> userName()
        Returns:
        Amazon QuickSight user name that you want to create for the user you are registering. Required only for users with an identity type of `QUICKSIGHT`.

      • userRole

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> userRole()
        Returns:
        Amazon QuickSight role for the user. Valid values: `READER`, `AUTHOR`, `ADMIN`, `READER_PRO`, `AUTHOR_PRO`, `ADMIN_PRO`, `RESTRICTED_AUTHOR`, `RESTRICTED_READER`. The following arguments are optional: