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

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("author@example.com")
            .iamArn("arn:aws:iam::123456789012:user/Example")
            .identityType("IAM")
            .namespace("foo")
            .sessionName("an-author")
            .userRole("AUTHOR")
            .build());
    }
}

Import

Importing is currently not supported on 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

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.

val email: Output<String>? = null

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

iamArn

val iamArn: Output<String>? = null

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

identityType

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.

namespace

val namespace: Output<String>? = null

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

sessionName

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.

userName

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.

userRole

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

toJava

open override fun toJava(): UserArgs