User

Resource for managing QuickSight User

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Quicksight.User("example", new Aws.Quicksight.UserArgs
        {
            Email = "author@example.com",
            IdentityType = "IAM",
            UserName = "an-author",
            UserRole = "AUTHOR",
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := quicksight.NewUser(ctx, "example", &quicksight.UserArgs{
            Email:        pulumi.String("author@example.com"),
            IdentityType: pulumi.String("IAM"),
            UserName:     pulumi.String("an-author"),
            UserRole:     pulumi.String("AUTHOR"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.quicksight.User("example",
    email="author@example.com",
    identity_type="IAM",
    user_name="an-author",
    user_role="AUTHOR")

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

const example = new aws.quicksight.User("example", {
    email: "author@example.com",
    identityType: "IAM",
    userName: "an-author",
    userRole: "AUTHOR",
});

Create a User Resource

new User(name: string, args: UserArgs, opts?: CustomResourceOptions);

def User(resource_name, opts=None, aws_account_id=None, email=None, iam_arn=None, identity_type=None, namespace=None, session_name=None, user_name=None, user_role=None, __props__=None);

func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)

public User(string name, UserArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

User Resource Properties

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

Inputs

The User resource accepts the following input properties:

Email string: The email address of the user that you want to register.
IdentityType string: Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts either IAM or QUICKSIGHT.
UserRole string: The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, or ADMIN
AwsAccountId string: 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.
IamArn string: The ARN of the IAM user or role that you are registering with Amazon QuickSight.
Namespace string: The namespace. Currently, you should set this to default.
SessionName string: The name of the IAM session to use when assuming roles that can embed QuickSight dashboards.
UserName string: The Amazon QuickSight user name that you want to create for the user you are registering.

Email string: The email address of the user that you want to register.
IdentityType string: Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts either IAM or QUICKSIGHT.
UserRole string: The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, or ADMIN
AwsAccountId string: 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.
IamArn string: The ARN of the IAM user or role that you are registering with Amazon QuickSight.
Namespace string: The namespace. Currently, you should set this to default.
SessionName string: The name of the IAM session to use when assuming roles that can embed QuickSight dashboards.
UserName string: The Amazon QuickSight user name that you want to create for the user you are registering.

email string: The email address of the user that you want to register.
identityType string: Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts either IAM or QUICKSIGHT.
userRole string: The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, or ADMIN
awsAccountId string: 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.
iamArn string: The ARN of the IAM user or role that you are registering with Amazon QuickSight.
namespace string: The namespace. Currently, you should set this to default.
sessionName string: The name of the IAM session to use when assuming roles that can embed QuickSight dashboards.
userName string: The Amazon QuickSight user name that you want to create for the user you are registering.

email str: The email address of the user that you want to register.
identity_type str: Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts either IAM or QUICKSIGHT.
user_role str: The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, or ADMIN
aws_account_id str: 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.
iam_arn str: The ARN of the IAM user or role that you are registering with Amazon QuickSight.
namespace str: The namespace. Currently, you should set this to default.
session_name str: The name of the IAM session to use when assuming roles that can embed QuickSight dashboards.
user_name str: The Amazon QuickSight user name that you want to create for the user you are registering.

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) of the user
Id string: The provider-assigned unique ID for this managed resource.

Arn string: Amazon Resource Name (ARN) of the user
Id string: The provider-assigned unique ID for this managed resource.

arn string: Amazon Resource Name (ARN) of the user
id string: The provider-assigned unique ID for this managed resource.

arn str: Amazon Resource Name (ARN) of the user
id str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, arn=None, aws_account_id=None, email=None, iam_arn=None, identity_type=None, namespace=None, session_name=None, user_name=None, user_role=None, __props__=None);

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)

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.

The following state arguments are supported:

Arn string: Amazon Resource Name (ARN) of the user
AwsAccountId string: 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 string: The email address of the user that you want to register.
IamArn string: The ARN of the IAM user or role that you are registering with Amazon QuickSight.
IdentityType string: Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts either IAM or QUICKSIGHT.
Namespace string: The namespace. Currently, you should set this to default.
SessionName string: The name of the IAM session to use when assuming roles that can embed QuickSight dashboards.
UserName string: The Amazon QuickSight user name that you want to create for the user you are registering.
UserRole string: The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, or ADMIN

Arn string: Amazon Resource Name (ARN) of the user
AwsAccountId string: 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 string: The email address of the user that you want to register.
IamArn string: The ARN of the IAM user or role that you are registering with Amazon QuickSight.
IdentityType string: Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts either IAM or QUICKSIGHT.
Namespace string: The namespace. Currently, you should set this to default.
SessionName string: The name of the IAM session to use when assuming roles that can embed QuickSight dashboards.
UserName string: The Amazon QuickSight user name that you want to create for the user you are registering.
UserRole string: The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, or ADMIN

arn string: Amazon Resource Name (ARN) of the user
awsAccountId string: 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 string: The email address of the user that you want to register.
iamArn string: The ARN of the IAM user or role that you are registering with Amazon QuickSight.
identityType string: Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts either IAM or QUICKSIGHT.
namespace string: The namespace. Currently, you should set this to default.
sessionName string: The name of the IAM session to use when assuming roles that can embed QuickSight dashboards.
userName string: The Amazon QuickSight user name that you want to create for the user you are registering.
userRole string: The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, or ADMIN

arn str: Amazon Resource Name (ARN) of the user
aws_account_id str: 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 str: The email address of the user that you want to register.
iam_arn str: The ARN of the IAM user or role that you are registering with Amazon QuickSight.
identity_type str: Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts either IAM or QUICKSIGHT.
namespace str: The namespace. Currently, you should set this to default.
session_name str: The name of the IAM session to use when assuming roles that can embed QuickSight dashboards.
user_name str: The Amazon QuickSight user name that you want to create for the user you are registering.
user_role str: The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, or ADMIN

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud