java.lang.Object
- com.pulumi.resources.Resource
- - com.pulumi.resources.CustomResource
  - - com.pulumi.aws.quicksight.User

public class User
extends com.pulumi.resources.CustomResource

Resource for managing QuickSight User ## Example Usage ### Create User With IAM Identity Type Using an IAM Role

 
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.quicksight.User;
 import com.pulumi.aws.quicksight.UserArgs;
 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()
             .email("author1@example.com")
             .identityType("IAM")
             .userRole("AUTHOR")
             .iamArn("arn:aws:iam::123456789012:role/AuthorRole")
             .sessionName("author1")
             .build());
 
     }
 }

### Create User With IAM Identity Type Using an IAM User

 
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.quicksight.User;
 import com.pulumi.aws.quicksight.UserArgs;
 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()
             .email("authorpro1@example.com")
             .identityType("IAM")
             .userRole("AUTHOR_PRO")
             .iamArn("arn:aws:iam::123456789012:user/authorpro1")
             .build());
 
     }
 }

### Create User With QuickSight Identity Type in Non-Default Namespace

 
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.quicksight.User;
 import com.pulumi.aws.quicksight.UserArgs;
 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()
             .email("reader1@example.com")
             .identityType("QUICKSIGHT")
             .userRole("READER")
             .namespace("example")
             .userName("reader1")
             .build());
 
     }
 }

## Import You cannot import this resource.

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>`	`awsAccountId()`
`com.pulumi.core.Output<java.lang.String>`	`email()`
`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>>`	`iamArn()`
`com.pulumi.core.Output<java.lang.String>`	`identityType()`
`com.pulumi.core.Output<java.util.Optional<java.lang.String>>`	`namespace()`
`com.pulumi.core.Output<java.lang.String>`	`region()`
`com.pulumi.core.Output<java.util.Optional<java.lang.String>>`	`sessionName()`
`com.pulumi.core.Output<java.lang.String>`	`userInvitationUrl()`
`com.pulumi.core.Output<java.lang.String>`	`userName()`
`com.pulumi.core.Output<java.lang.String>`	`userRole()`

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:
    
    ARN for the user.
  - awsAccountId
```
public 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 com.pulumi.core.Output<java.lang.String> email()
```
    Returns:
    
    Email address of the user that you want to register.
  - iamArn
```
public com.pulumi.core.Output<java.util.Optional<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 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 com.pulumi.core.Output<java.util.Optional<java.lang.String>> namespace()
```
    Returns:
    
    Amazon QuickSight namespace to create the user in. Defaults to `default`.
  - 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.
  - sessionName
```
public com.pulumi.core.Output<java.util.Optional<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 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 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 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:
  - 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.

Class User

Nested Class Summary

Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

Nested classes/interfaces inherited from class com.pulumi.resources.Resource

Field Summary

Fields inherited from class com.pulumi.resources.Resource

Constructor Summary

Method Summary

Methods inherited from class com.pulumi.resources.CustomResource

Methods inherited from class com.pulumi.resources.Resource

Methods inherited from class java.lang.Object

Constructor Detail

User

User

User

Method Detail

arn

awsAccountId

email

iamArn

identityType

namespace

region

sessionName

userInvitationUrl

userName

userRole

get