Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. quicksight
  5. User
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.quicksight.User

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

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

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

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

    Create User Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
    @overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         email: Optional[str] = None,
         identity_type: Optional[str] = None,
         user_role: Optional[str] = None,
         aws_account_id: Optional[str] = None,
         iam_arn: Optional[str] = None,
         namespace: Optional[str] = None,
         session_name: Optional[str] = None,
         user_name: Optional[str] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

    type: aws:quicksight:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleuserResourceResourceFromQuicksightuser = new Aws.Quicksight.User("exampleuserResourceResourceFromQuicksightuser", new()
{
    Email = "string",
    IdentityType = "string",
    UserRole = "string",
    AwsAccountId = "string",
    IamArn = "string",
    Namespace = "string",
    SessionName = "string",
    UserName = "string",
});

    example, err := quicksight.NewUser(ctx, "exampleuserResourceResourceFromQuicksightuser", &quicksight.UserArgs{
	Email:        pulumi.String("string"),
	IdentityType: pulumi.String("string"),
	UserRole:     pulumi.String("string"),
	AwsAccountId: pulumi.String("string"),
	IamArn:       pulumi.String("string"),
	Namespace:    pulumi.String("string"),
	SessionName:  pulumi.String("string"),
	UserName:     pulumi.String("string"),
})

    var exampleuserResourceResourceFromQuicksightuser = new User("exampleuserResourceResourceFromQuicksightuser", UserArgs.builder()
    .email("string")
    .identityType("string")
    .userRole("string")
    .awsAccountId("string")
    .iamArn("string")
    .namespace("string")
    .sessionName("string")
    .userName("string")
    .build());

    exampleuser_resource_resource_from_quicksightuser = aws.quicksight.User("exampleuserResourceResourceFromQuicksightuser",
    email="string",
    identity_type="string",
    user_role="string",
    aws_account_id="string",
    iam_arn="string",
    namespace="string",
    session_name="string",
    user_name="string")

    const exampleuserResourceResourceFromQuicksightuser = new aws.quicksight.User("exampleuserResourceResourceFromQuicksightuser", {
    email: "string",
    identityType: "string",
    userRole: "string",
    awsAccountId: "string",
    iamArn: "string",
    namespace: "string",
    sessionName: "string",
    userName: "string",
});

    type: aws:quicksight:User
properties:
    awsAccountId: string
    email: string
    iamArn: string
    identityType: string
    namespace: string
    sessionName: string
    userName: string
    userRole: string

    User Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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. If IAM is specified, the iam_arn must also be specified.
    UserRole string
    The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO or ADMIN_PRO.
    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 Amazon Quicksight namespace to create the user in. Defaults to default.
    SessionName string
    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 string
    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.
    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. If IAM is specified, the iam_arn must also be specified.
    UserRole string
    The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO or ADMIN_PRO.
    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 Amazon Quicksight namespace to create the user in. Defaults to default.
    SessionName string
    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 string
    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.
    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. If IAM is specified, the iam_arn must also be specified.
    userRole String
    The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO or ADMIN_PRO.
    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 Amazon Quicksight namespace to create the user in. Defaults to default.
    sessionName String
    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 String
    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.
    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. If IAM is specified, the iam_arn must also be specified.
    userRole string
    The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO or ADMIN_PRO.
    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 Amazon Quicksight namespace to create the user in. Defaults to default.
    sessionName string
    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 string
    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.
    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. If IAM is specified, the iam_arn must also be specified.
    user_role str
    The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO or ADMIN_PRO.
    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 Amazon Quicksight namespace to create the user in. Defaults to default.
    session_name str
    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.
    user_name str
    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.
    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. If IAM is specified, the iam_arn must also be specified.
    userRole String
    The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO or ADMIN_PRO.
    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 Amazon Quicksight namespace to create the user in. Defaults to default.
    sessionName String
    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 String
    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.

    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 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.
    arn String
    Amazon Resource Name (ARN) of the user
    id String
    The provider-assigned unique ID for this managed resource.

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        aws_account_id: Optional[str] = None,
        email: Optional[str] = None,
        iam_arn: Optional[str] = None,
        identity_type: Optional[str] = None,
        namespace: Optional[str] = None,
        session_name: Optional[str] = None,
        user_name: Optional[str] = None,
        user_role: Optional[str] = None) -> User
    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)
    public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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. If IAM is specified, the iam_arn must also be specified.
    Namespace string
    The Amazon Quicksight namespace to create the user in. Defaults to default.
    SessionName string
    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 string
    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 string
    The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO or ADMIN_PRO.
    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. If IAM is specified, the iam_arn must also be specified.
    Namespace string
    The Amazon Quicksight namespace to create the user in. Defaults to default.
    SessionName string
    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 string
    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 string
    The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO or ADMIN_PRO.
    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. If IAM is specified, the iam_arn must also be specified.
    namespace String
    The Amazon Quicksight namespace to create the user in. Defaults to default.
    sessionName String
    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 String
    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 String
    The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO or ADMIN_PRO.
    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. If IAM is specified, the iam_arn must also be specified.
    namespace string
    The Amazon Quicksight namespace to create the user in. Defaults to default.
    sessionName string
    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 string
    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 string
    The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO or ADMIN_PRO.
    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. If IAM is specified, the iam_arn must also be specified.
    namespace str
    The Amazon Quicksight namespace to create the user in. Defaults to default.
    session_name str
    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.
    user_name str
    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.
    user_role str
    The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO or ADMIN_PRO.
    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. If IAM is specified, the iam_arn must also be specified.
    namespace String
    The Amazon Quicksight namespace to create the user in. Defaults to default.
    sessionName String
    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 String
    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 String
    The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, ADMIN, READER_PRO, AUTHOR_PRO or ADMIN_PRO.

    Import

    You cannot import this resource.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws