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

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.quicksight.User("example", {
sessionName: "an-author",
email: "author@example.com",
namespace: "foo",
identityType: "IAM",
iamArn: "arn:aws:iam::123456789012:user/Example",
userRole: "AUTHOR",
});
import pulumi
import pulumi_aws as aws
example = aws.quicksight.User("example",
session_name="an-author",
email="author@example.com",
namespace="foo",
identity_type="IAM",
iam_arn="arn:aws:iam::123456789012:user/Example",
user_role="AUTHOR")
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()
{
SessionName = "an-author",
Email = "author@example.com",
Namespace = "foo",
IdentityType = "IAM",
IamArn = "arn:aws:iam::123456789012:user/Example",
UserRole = "AUTHOR",
});
});
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{
SessionName: pulumi.String("an-author"),
Email: pulumi.String("author@example.com"),
Namespace: pulumi.String("foo"),
IdentityType: pulumi.String("IAM"),
IamArn: pulumi.String("arn:aws:iam::123456789012:user/Example"),
UserRole: pulumi.String("AUTHOR"),
})
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()
.sessionName("an-author")
.email("author@example.com")
.namespace("foo")
.identityType("IAM")
.iamArn("arn:aws:iam::123456789012:user/Example")
.userRole("AUTHOR")
.build());
}
}
resources:
example:
type: aws:quicksight:User
properties:
sessionName: an-author
email: author@example.com
namespace: foo
identityType: IAM
iamArn: arn:aws:iam::123456789012:user/Example
userRole: AUTHOR

Import

You cannot import this resource.

Constructors

Link copied to clipboard
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

Link copied to clipboard
val awsAccountId: Output<String>? = null

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.

Link copied to clipboard
val email: Output<String>? = null

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

Link copied to clipboard
val iamArn: Output<String>? = null

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

Link copied to clipboard
val identityType: Output<String>? = null

Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts either IAM or QUICKSIGHT. If IAM is specified, the iam_arn must also be specified.

Link copied to clipboard
val namespace: Output<String>? = null

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

Link copied to clipboard
val sessionName: Output<String>? = null

The 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.

Link copied to clipboard
val userName: Output<String>? = null

The Amazon QuickSight user name that you want to create for the user you are registering. Only valid for registering a user with identity_type set to QUICKSIGHT.

Link copied to clipboard
val userRole: Output<String>? = null

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

Functions

Link copied to clipboard
open override fun toJava(): UserArgs