Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. quicksight
  5. User
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.quicksight.User

Explore with Pulumi AI

aws logo
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

    Resource for managing QuickSight User

    Example Usage

    Create User With IAM Identity Type Using an IAM Role

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.quicksight.User("example", {
    email: "author1@example.com",
    identityType: "IAM",
    userRole: "AUTHOR",
    iamArn: "arn:aws:iam::123456789012:role/AuthorRole",
    sessionName: "author1",
});

    import pulumi
import pulumi_aws as aws

example = aws.quicksight.User("example",
    email="author1@example.com",
    identity_type="IAM",
    user_role="AUTHOR",
    iam_arn="arn:aws:iam::123456789012:role/AuthorRole",
    session_name="author1")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/quicksight"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := quicksight.NewUser(ctx, "example", &quicksight.UserArgs{
			Email:        pulumi.String("author1@example.com"),
			IdentityType: pulumi.String("IAM"),
			UserRole:     pulumi.String("AUTHOR"),
			IamArn:       pulumi.String("arn:aws:iam::123456789012:role/AuthorRole"),
			SessionName:  pulumi.String("author1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Quicksight.User("example", new()
    {
        Email = "author1@example.com",
        IdentityType = "IAM",
        UserRole = "AUTHOR",
        IamArn = "arn:aws:iam::123456789012:role/AuthorRole",
        SessionName = "author1",
    });

});

    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.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()
            .email("author1@example.com")
            .identityType("IAM")
            .userRole("AUTHOR")
            .iamArn("arn:aws:iam::123456789012:role/AuthorRole")
            .sessionName("author1")
            .build());

    }
}

    resources:
  example:
    type: aws:quicksight:User
    properties:
      email: author1@example.com
      identityType: IAM
      userRole: AUTHOR
      iamArn: arn:aws:iam::123456789012:role/AuthorRole
      sessionName: author1

    Create User With IAM Identity Type Using an IAM User

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.quicksight.User("example", {
    email: "authorpro1@example.com",
    identityType: "IAM",
    userRole: "AUTHOR_PRO",
    iamArn: "arn:aws:iam::123456789012:user/authorpro1",
});

    import pulumi
import pulumi_aws as aws

example = aws.quicksight.User("example",
    email="authorpro1@example.com",
    identity_type="IAM",
    user_role="AUTHOR_PRO",
    iam_arn="arn:aws:iam::123456789012:user/authorpro1")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/quicksight"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := quicksight.NewUser(ctx, "example", &quicksight.UserArgs{
			Email:        pulumi.String("authorpro1@example.com"),
			IdentityType: pulumi.String("IAM"),
			UserRole:     pulumi.String("AUTHOR_PRO"),
			IamArn:       pulumi.String("arn:aws:iam::123456789012:user/authorpro1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Quicksight.User("example", new()
    {
        Email = "authorpro1@example.com",
        IdentityType = "IAM",
        UserRole = "AUTHOR_PRO",
        IamArn = "arn:aws:iam::123456789012:user/authorpro1",
    });

});

    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.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()
            .email("authorpro1@example.com")
            .identityType("IAM")
            .userRole("AUTHOR_PRO")
            .iamArn("arn:aws:iam::123456789012:user/authorpro1")
            .build());

    }
}

    resources:
  example:
    type: aws:quicksight:User
    properties:
      email: authorpro1@example.com
      identityType: IAM
      userRole: AUTHOR_PRO
      iamArn: arn:aws:iam::123456789012:user/authorpro1

    Create User With QuickSight Identity Type in Non-Default Namespace

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.quicksight.User("example", {
    email: "reader1@example.com",
    identityType: "QUICKSIGHT",
    userRole: "READER",
    namespace: "example",
    userName: "reader1",
});

    import pulumi
import pulumi_aws as aws

example = aws.quicksight.User("example",
    email="reader1@example.com",
    identity_type="QUICKSIGHT",
    user_role="READER",
    namespace="example",
    user_name="reader1")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/quicksight"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := quicksight.NewUser(ctx, "example", &quicksight.UserArgs{
			Email:        pulumi.String("reader1@example.com"),
			IdentityType: pulumi.String("QUICKSIGHT"),
			UserRole:     pulumi.String("READER"),
			Namespace:    pulumi.String("example"),
			UserName:     pulumi.String("reader1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Quicksight.User("example", new()
    {
        Email = "reader1@example.com",
        IdentityType = "QUICKSIGHT",
        UserRole = "READER",
        Namespace = "example",
        UserName = "reader1",
    });

});

    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.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()
            .email("reader1@example.com")
            .identityType("QUICKSIGHT")
            .userRole("READER")
            .namespace("example")
            .userName("reader1")
            .build());

    }
}

    resources:
  example:
    type: aws:quicksight:User
    properties:
      email: reader1@example.com
      identityType: QUICKSIGHT
      userRole: READER
      namespace: example
      userName: reader1

    Create User Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
    @overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         email: Optional[str] = None,
         identity_type: Optional[str] = None,
         user_role: Optional[str] = None,
         aws_account_id: Optional[str] = None,
         iam_arn: Optional[str] = None,
         namespace: Optional[str] = None,
         session_name: Optional[str] = None,
         user_name: Optional[str] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

    type: aws:quicksight:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleuserResourceResourceFromQuicksightuser = new Aws.Quicksight.User("exampleuserResourceResourceFromQuicksightuser", new()
{
    Email = "string",
    IdentityType = "string",
    UserRole = "string",
    AwsAccountId = "string",
    IamArn = "string",
    Namespace = "string",
    SessionName = "string",
    UserName = "string",
});

    example, err := quicksight.NewUser(ctx, "exampleuserResourceResourceFromQuicksightuser", &quicksight.UserArgs{
	Email:        pulumi.String("string"),
	IdentityType: pulumi.String("string"),
	UserRole:     pulumi.String("string"),
	AwsAccountId: pulumi.String("string"),
	IamArn:       pulumi.String("string"),
	Namespace:    pulumi.String("string"),
	SessionName:  pulumi.String("string"),
	UserName:     pulumi.String("string"),
})

    var exampleuserResourceResourceFromQuicksightuser = new User("exampleuserResourceResourceFromQuicksightuser", UserArgs.builder()
    .email("string")
    .identityType("string")
    .userRole("string")
    .awsAccountId("string")
    .iamArn("string")
    .namespace("string")
    .sessionName("string")
    .userName("string")
    .build());

    exampleuser_resource_resource_from_quicksightuser = aws.quicksight.User("exampleuserResourceResourceFromQuicksightuser",
    email="string",
    identity_type="string",
    user_role="string",
    aws_account_id="string",
    iam_arn="string",
    namespace="string",
    session_name="string",
    user_name="string")

    const exampleuserResourceResourceFromQuicksightuser = new aws.quicksight.User("exampleuserResourceResourceFromQuicksightuser", {
    email: "string",
    identityType: "string",
    userRole: "string",
    awsAccountId: "string",
    iamArn: "string",
    namespace: "string",
    sessionName: "string",
    userName: "string",
});

    type: aws:quicksight:User
properties:
    awsAccountId: string
    email: string
    iamArn: string
    identityType: string
    namespace: string
    sessionName: string
    userName: string
    userRole: string

    User Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The User resource accepts the following input properties:

    Email string
    Email address of the user that you want to register.
    IdentityType string
    Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: IAM, QUICKSIGHT.
    UserRole string

    Amazon QuickSight role for the user. Value values: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO, ADMIN_PRO.

    The following arguments are optional:

    AwsAccountId string
    ID for the AWS account that the user is in. Use the ID for the AWS account that contains your Amazon QuickSight account.
    IamArn string
    ARN of the IAM user or role that you are registering with Amazon QuickSight. Required only for users with an identity type of IAM.
    Namespace string
    The Amazon Quicksight namespace to create the user in. Defaults to default.
    SessionName string
    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 string
    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.
    Email string
    Email address of the user that you want to register.
    IdentityType string
    Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: IAM, QUICKSIGHT.
    UserRole string

    Amazon QuickSight role for the user. Value values: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO, ADMIN_PRO.

    The following arguments are optional:

    AwsAccountId string
    ID for the AWS account that the user is in. Use the ID for the AWS account that contains your Amazon QuickSight account.
    IamArn string
    ARN of the IAM user or role that you are registering with Amazon QuickSight. Required only for users with an identity type of IAM.
    Namespace string
    The Amazon Quicksight namespace to create the user in. Defaults to default.
    SessionName string
    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 string
    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.
    email String
    Email address of the user that you want to register.
    identityType String
    Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: IAM, QUICKSIGHT.
    userRole String

    Amazon QuickSight role for the user. Value values: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO, ADMIN_PRO.

    The following arguments are optional:

    awsAccountId String
    ID for the AWS account that the user is in. Use the ID for the AWS account that contains your Amazon QuickSight account.
    iamArn String
    ARN of the IAM user or role that you are registering with Amazon QuickSight. Required only for users with an identity type of IAM.
    namespace String
    The Amazon Quicksight namespace to create the user in. Defaults to default.
    sessionName String
    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 String
    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.
    email string
    Email address of the user that you want to register.
    identityType string
    Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: IAM, QUICKSIGHT.
    userRole string

    Amazon QuickSight role for the user. Value values: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO, ADMIN_PRO.

    The following arguments are optional:

    awsAccountId string
    ID for the AWS account that the user is in. Use the ID for the AWS account that contains your Amazon QuickSight account.
    iamArn string
    ARN of the IAM user or role that you are registering with Amazon QuickSight. Required only for users with an identity type of IAM.
    namespace string
    The Amazon Quicksight namespace to create the user in. Defaults to default.
    sessionName string
    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 string
    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.
    email str
    Email address of the user that you want to register.
    identity_type str
    Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: IAM, QUICKSIGHT.
    user_role str

    Amazon QuickSight role for the user. Value values: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO, ADMIN_PRO.

    The following arguments are optional:

    aws_account_id str
    ID for the AWS account that the user is in. Use the ID for the AWS account that contains your Amazon QuickSight account.
    iam_arn str
    ARN of the IAM user or role that you are registering with Amazon QuickSight. Required only for users with an identity type of IAM.
    namespace str
    The Amazon Quicksight namespace to create the user in. Defaults to default.
    session_name str
    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.
    user_name str
    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.
    email String
    Email address of the user that you want to register.
    identityType String
    Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: IAM, QUICKSIGHT.
    userRole String

    Amazon QuickSight role for the user. Value values: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO, ADMIN_PRO.

    The following arguments are optional:

    awsAccountId String
    ID for the AWS account that the user is in. Use the ID for the AWS account that contains your Amazon QuickSight account.
    iamArn String
    ARN of the IAM user or role that you are registering with Amazon QuickSight. Required only for users with an identity type of IAM.
    namespace String
    The Amazon Quicksight namespace to create the user in. Defaults to default.
    sessionName String
    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 String
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

    Arn string
    Amazon Resource Name (ARN) for the user.
    Id string
    The provider-assigned unique ID for this managed resource.
    UserInvitationUrl string
    URL the user visits to complete registration and provide a password. Returned only for users with an identity type of QUICKSIGHT.
    Arn string
    Amazon Resource Name (ARN) for the user.
    Id string
    The provider-assigned unique ID for this managed resource.
    UserInvitationUrl string
    URL the user visits to complete registration and provide a password. Returned only for users with an identity type of QUICKSIGHT.
    arn String
    Amazon Resource Name (ARN) for the user.
    id String
    The provider-assigned unique ID for this managed resource.
    userInvitationUrl String
    URL the user visits to complete registration and provide a password. Returned only for users with an identity type of QUICKSIGHT.
    arn string
    Amazon Resource Name (ARN) for the user.
    id string
    The provider-assigned unique ID for this managed resource.
    userInvitationUrl string
    URL the user visits to complete registration and provide a password. Returned only for users with an identity type of QUICKSIGHT.
    arn str
    Amazon Resource Name (ARN) for the user.
    id str
    The provider-assigned unique ID for this managed resource.
    user_invitation_url str
    URL the user visits to complete registration and provide a password. Returned only for users with an identity type of QUICKSIGHT.
    arn String
    Amazon Resource Name (ARN) for the user.
    id String
    The provider-assigned unique ID for this managed resource.
    userInvitationUrl String
    URL the user visits to complete registration and provide a password. Returned only for users with an identity type of QUICKSIGHT.

    Look up Existing User Resource

    Get an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: UserState, opts?: CustomResourceOptions): User
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        aws_account_id: Optional[str] = None,
        email: Optional[str] = None,
        iam_arn: Optional[str] = None,
        identity_type: Optional[str] = None,
        namespace: Optional[str] = None,
        session_name: Optional[str] = None,
        user_invitation_url: Optional[str] = None,
        user_name: Optional[str] = None,
        user_role: Optional[str] = None) -> User
    func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
    public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
    public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
    resources:  _:    type: aws:quicksight:User    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    Amazon Resource Name (ARN) for the user.
    AwsAccountId string
    ID for the AWS account that the user is in. Use the ID for the AWS account that contains your Amazon QuickSight account.
    Email string
    Email address of the user that you want to register.
    IamArn string
    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 string
    Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: IAM, QUICKSIGHT.
    Namespace string
    The Amazon Quicksight namespace to create the user in. Defaults to default.
    SessionName string
    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 string
    URL the user visits to complete registration and provide a password. Returned only for users with an identity type of QUICKSIGHT.
    UserName string
    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 string

    Amazon QuickSight role for the user. Value values: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO, ADMIN_PRO.

    The following arguments are optional:

    Arn string
    Amazon Resource Name (ARN) for the user.
    AwsAccountId string
    ID for the AWS account that the user is in. Use the ID for the AWS account that contains your Amazon QuickSight account.
    Email string
    Email address of the user that you want to register.
    IamArn string
    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 string
    Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: IAM, QUICKSIGHT.
    Namespace string
    The Amazon Quicksight namespace to create the user in. Defaults to default.
    SessionName string
    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 string
    URL the user visits to complete registration and provide a password. Returned only for users with an identity type of QUICKSIGHT.
    UserName string
    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 string

    Amazon QuickSight role for the user. Value values: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO, ADMIN_PRO.

    The following arguments are optional:

    arn String
    Amazon Resource Name (ARN) for the user.
    awsAccountId String
    ID for the AWS account that the user is in. Use the ID for the AWS account that contains your Amazon QuickSight account.
    email String
    Email address of the user that you want to register.
    iamArn String
    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 String
    Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: IAM, QUICKSIGHT.
    namespace String
    The Amazon Quicksight namespace to create the user in. Defaults to default.
    sessionName String
    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 String
    URL the user visits to complete registration and provide a password. Returned only for users with an identity type of QUICKSIGHT.
    userName String
    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 String

    Amazon QuickSight role for the user. Value values: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO, ADMIN_PRO.

    The following arguments are optional:

    arn string
    Amazon Resource Name (ARN) for the user.
    awsAccountId string
    ID for the AWS account that the user is in. Use the ID for the AWS account that contains your Amazon QuickSight account.
    email string
    Email address of the user that you want to register.
    iamArn string
    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 string
    Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: IAM, QUICKSIGHT.
    namespace string
    The Amazon Quicksight namespace to create the user in. Defaults to default.
    sessionName string
    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 string
    URL the user visits to complete registration and provide a password. Returned only for users with an identity type of QUICKSIGHT.
    userName string
    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 string

    Amazon QuickSight role for the user. Value values: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO, ADMIN_PRO.

    The following arguments are optional:

    arn str
    Amazon Resource Name (ARN) for the user.
    aws_account_id str
    ID for the AWS account that the user is in. Use the ID for the AWS account that contains your Amazon QuickSight account.
    email str
    Email address of the user that you want to register.
    iam_arn str
    ARN of the IAM user or role that you are registering with Amazon QuickSight. Required only for users with an identity type of IAM.
    identity_type str
    Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: IAM, QUICKSIGHT.
    namespace str
    The Amazon Quicksight namespace to create the user in. Defaults to default.
    session_name str
    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.
    user_invitation_url str
    URL the user visits to complete registration and provide a password. Returned only for users with an identity type of QUICKSIGHT.
    user_name str
    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.
    user_role str

    Amazon QuickSight role for the user. Value values: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO, ADMIN_PRO.

    The following arguments are optional:

    arn String
    Amazon Resource Name (ARN) for the user.
    awsAccountId String
    ID for the AWS account that the user is in. Use the ID for the AWS account that contains your Amazon QuickSight account.
    email String
    Email address of the user that you want to register.
    iamArn String
    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 String
    Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: IAM, QUICKSIGHT.
    namespace String
    The Amazon Quicksight namespace to create the user in. Defaults to default.
    sessionName String
    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 String
    URL the user visits to complete registration and provide a password. Returned only for users with an identity type of QUICKSIGHT.
    userName String
    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 String

    Amazon QuickSight role for the user. Value values: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO, ADMIN_PRO.

    The following arguments are optional:

    Import

    You cannot import this resource.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-aws