Skip to content

Resource: awsQuicksightUser

Resource for managing QuickSight User

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.quicksightUser.QuicksightUser(this, "example", {
  email: "author@example.com",
  iamArn: "arn:aws:iam::123456789012:user/Example",
  identityType: "IAM",
  namespace: "foo",
  sessionName: "an-author",
  userRole: "AUTHOR",
});

Argument Reference

The following arguments are supported:

  • email - (Required) The email address of the user that you want to register.
  • identityType - (Required) Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts either iam or quicksight. If iam is specified, the iamArn must also be specified.
  • userRole - (Required) The Amazon QuickSight role of the user. The user role can be one of the following: reader, author, or admin
  • userName - (Optional) The Amazon QuickSight user name that you want to create for the user you are registering. Only valid for registering a user with identityType set to quicksight.
  • awsAccountId - (Optional) 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 - (Optional) The ARN of the IAM user or role that you are registering with Amazon QuickSight.
  • namespace - (Optional) The Amazon Quicksight namespace to create the user in. Defaults to default.
  • sessionName - (Optional) 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.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • arn - Amazon Resource Name (ARN) of the user

Import

Importing is currently not supported on this resource.