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>> sessionName()  
      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:
        Amazon Resource Name (ARN) of the user

      • awsAccountId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> awsAccountId()
        Returns:
        The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

      • email

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

      • iamArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> iamArn()
        Returns:
        The ARN of the IAM user or role that you are registering with Amazon QuickSight.

      • identityType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> identityType()
        Returns:
        Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts either `IAM` or `QUICKSIGHT`. If `IAM` is specified, the `iam_arn` must also be specified.

      • namespace

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

      • sessionName

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

      • userName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> userName()
        Returns:
        The Amazon QuickSight user name that you want to create for the user you are registering. Only valid for registering a user with `identity_type` set to `QUICKSIGHT`.

      • userRole

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> userRole()
        Returns:
        The Amazon QuickSight role of the user. The user role can be one of the following: `READER`, `AUTHOR`, or `ADMIN`