pulumi-aws-kotlin/com.pulumi.aws.quicksight.kotlin/UserArgs

UserArgs

data class UserArgs(val awsAccountId: Output<String>? = null, val email: Output<String>? = null, val iamArn: Output<String>? = null, val identityType: Output<String>? = null, val namespace: Output<String>? = null, val sessionName: Output<String>? = null, val userName: Output<String>? = null, val userRole: Output<String>? = null) : ConvertibleToJava<UserArgs>

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")

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 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
	})
}

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")

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 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
	})
}

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")

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 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
	})
}

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

Import

You cannot import this resource.

Constructors

UserArgs

constructor(awsAccountId: Output<String>? = null, email: Output<String>? = null, iamArn: Output<String>? = null, identityType: Output<String>? = null, namespace: Output<String>? = null, sessionName: Output<String>? = null, userName: Output<String>? = null, userRole: Output<String>? = null)

Properties

awsAccountId

val awsAccountId: Output<String>? = null

ID for the AWS account that the user is in. Use the ID for the AWS account that contains your Amazon QuickSight account.

val email: Output<String>? = null

Email address of the user that you want to register.

iamArn

val iamArn: Output<String>? = null

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

val identityType: Output<String>? = null

Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: IAM, QUICKSIGHT.

namespace

val namespace: Output<String>? = null

The Amazon Quicksight namespace to create the user in. Defaults to default.

sessionName

val sessionName: Output<String>? = null

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

val userName: Output<String>? = null

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

val userRole: Output<String>? = null

Amazon QuickSight role for the user. Value values: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO, ADMIN_PRO. The following arguments are optional:

Functions

toJava

open override fun toJava(): UserArgs