1. Docs
  2. Reference
  3. API
  4. @pulumi/aws
  5. quicksight

Module quicksight

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

Others

Resources

Resource Group

class Group extends CustomResource

Resource for managing QuickSight Group

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.quicksight.Group("example", {
    groupName: "tf-example",
});

constructor

new Group(name: string, args: GroupArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GroupState, opts?: pulumi.CustomResourceOptions): Group

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Group

Returns true if the given object is an instance of Group. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of group

property awsAccountId

public awsAccountId: pulumi.Output<string>;

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

property description

public description: pulumi.Output<string | undefined>;

A description for the group.

property groupName

public groupName: pulumi.Output<string>;

A name for the group.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property namespace

public namespace: pulumi.Output<string | undefined>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource User

class User extends CustomResource

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", {
    email: "author@example.com",
    identityType: "IAM",
    userName: "an-author",
    userRole: "AUTHOR",
});

constructor

new User(name: string, args: UserArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UserState, opts?: pulumi.CustomResourceOptions): User

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is User

Returns true if the given object is an instance of User. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of the user

property awsAccountId

public awsAccountId: pulumi.Output<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.

property email

public email: pulumi.Output<string>;

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

property iamArn

public iamArn: pulumi.Output<string | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identityType

public identityType: pulumi.Output<string>;

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

property namespace

public namespace: pulumi.Output<string | undefined>;

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

property sessionName

public sessionName: pulumi.Output<string | undefined>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userName

public userName: pulumi.Output<string | undefined>;

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

property userRole

public userRole: pulumi.Output<string>;

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

Others

interface GroupArgs

interface GroupArgs

The set of arguments for constructing a Group resource.

property awsAccountId

awsAccountId?: pulumi.Input<string>;

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

property description

description?: pulumi.Input<string>;

A description for the group.

property groupName

groupName: pulumi.Input<string>;

A name for the group.

property namespace

namespace?: pulumi.Input<string>;

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

interface GroupState

interface GroupState

Input properties used for looking up and filtering Group resources.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of group

property awsAccountId

awsAccountId?: pulumi.Input<string>;

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

property description

description?: pulumi.Input<string>;

A description for the group.

property groupName

groupName?: pulumi.Input<string>;

A name for the group.

property namespace

namespace?: pulumi.Input<string>;

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

interface UserArgs

interface UserArgs

The set of arguments for constructing a User resource.

property awsAccountId

awsAccountId?: pulumi.Input<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.

property email

email: pulumi.Input<string>;

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

property iamArn

iamArn?: pulumi.Input<string>;

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

property identityType

identityType: pulumi.Input<string>;

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

property namespace

namespace?: pulumi.Input<string>;

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

property sessionName

sessionName?: pulumi.Input<string>;

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

property userName

userName?: pulumi.Input<string>;

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

property userRole

userRole: pulumi.Input<string>;

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

interface UserState

interface UserState

Input properties used for looking up and filtering User resources.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of the user

property awsAccountId

awsAccountId?: pulumi.Input<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.

property email

email?: pulumi.Input<string>;

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

property iamArn

iamArn?: pulumi.Input<string>;

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

property identityType

identityType?: pulumi.Input<string>;

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

property namespace

namespace?: pulumi.Input<string>;

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

property sessionName

sessionName?: pulumi.Input<string>;

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

property userName

userName?: pulumi.Input<string>;

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

property userRole

userRole?: pulumi.Input<string>;

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