Class 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",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

User

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Quicksight

Assembly: Pulumi.Aws.dll

Syntax

public class User : CustomResource

Constructors

User(String, UserArgs, CustomResourceOptions)

Create a User resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
UserArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

Amazon Resource Name (ARN) of the user

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

AwsAccountId

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.

Declaration

public Output<string> AwsAccountId { get; }

Property Value

Type	Description
Output<System.String>

Email

The email address of the user that you want to register.

Declaration

public Output<string> Email { get; }

Property Value

Type	Description
Output<System.String>

IamArn

The ARN of the IAM user or role that you are registering with Amazon QuickSight.

Declaration

public Output<string> IamArn { get; }

Property Value

Type	Description
Output<System.String>

IdentityType

Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts either IAM or QUICKSIGHT.

Declaration

public Output<string> IdentityType { get; }

Property Value

Type	Description
Output<System.String>

Namespace

The namespace. Currently, you should set this to default.

Declaration

public Output<string> Namespace { get; }

Property Value

Type	Description
Output<System.String>

SessionName

The name of the IAM session to use when assuming roles that can embed QuickSight dashboards.

Declaration

public Output<string> SessionName { get; }

Property Value

Type	Description
Output<System.String>

UserName

The Amazon QuickSight user name that you want to create for the user you are registering.

Declaration

public Output<string> UserName { get; }

Property Value

Type	Description
Output<System.String>

UserRole

The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, or ADMIN

Declaration

public Output<string> UserRole { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, UserState, CustomResourceOptions)

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

Declaration

public static User Get(string name, Input<string> id, UserState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
UserState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
User