quicksight¶

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.

class pulumi_aws.quicksight.Group(resource_name, opts=None, aws_account_id=None, description=None, group_name=None, namespace=None, __props__=None, __name__=None, __opts__=None)¶

Resource for managing QuickSight Group

import pulumi
import pulumi_aws as aws

example = aws.quicksight.Group("example", group_name="tf-example")

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• aws_account_id (pulumi.Input[str]) – 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.

• description (pulumi.Input[str]) – A description for the group.

• group_name (pulumi.Input[str]) – A name for the group.

• namespace (pulumi.Input[str]) – The namespace. Currently, you should set this to default.

arn: pulumi.Output[str] = None¶

Amazon Resource Name (ARN) of group

aws_account_id: pulumi.Output[str] = None¶

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.

description: pulumi.Output[str] = None¶

A description for the group.

group_name: pulumi.Output[str] = None¶

A name for the group.

namespace: pulumi.Output[str] = None¶

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

static get(resource_name, id, opts=None, arn=None, aws_account_id=None, description=None, group_name=None, namespace=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of group

• aws_account_id (pulumi.Input[str]) – 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.

• description (pulumi.Input[str]) – A description for the group.

• group_name (pulumi.Input[str]) – A name for the group.

• namespace (pulumi.Input[str]) – The namespace. Currently, you should set this to default.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.quicksight.User(resource_name, opts=None, aws_account_id=None, email=None, iam_arn=None, identity_type=None, namespace=None, session_name=None, user_name=None, user_role=None, __props__=None, __name__=None, __opts__=None)¶

Resource for managing QuickSight User

import pulumi
import pulumi_aws as aws

example = aws.quicksight.User("example",
    email="author@example.com",
    identity_type="IAM",
    user_name="an-author",
    user_role="AUTHOR")

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• aws_account_id (pulumi.Input[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 (pulumi.Input[str]) – The email address of the user that you want to register.

• iam_arn (pulumi.Input[str]) – The ARN of the IAM user or role that you are registering with Amazon QuickSight.

• identity_type (pulumi.Input[str]) – Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts either IAM or QUICKSIGHT.

• namespace (pulumi.Input[str]) – The namespace. Currently, you should set this to default.

• session_name (pulumi.Input[str]) – The name of the IAM session to use when assuming roles that can embed QuickSight dashboards.

• user_name (pulumi.Input[str]) – The Amazon QuickSight user name that you want to create for the user you are registering.

• user_role (pulumi.Input[str]) – The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, or ADMIN

arn: pulumi.Output[str] = None¶

Amazon Resource Name (ARN) of the user

aws_account_id: pulumi.Output[str] = None¶

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: pulumi.Output[str] = None¶

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

iam_arn: pulumi.Output[str] = None¶

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

identity_type: pulumi.Output[str] = None¶

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

namespace: pulumi.Output[str] = None¶

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

session_name: pulumi.Output[str] = None¶

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

user_name: pulumi.Output[str] = None¶

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

user_role: pulumi.Output[str] = None¶

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

static get(resource_name, id, opts=None, arn=None, aws_account_id=None, email=None, iam_arn=None, identity_type=None, namespace=None, session_name=None, user_name=None, user_role=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the user

• aws_account_id (pulumi.Input[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 (pulumi.Input[str]) – The email address of the user that you want to register.

• iam_arn (pulumi.Input[str]) – The ARN of the IAM user or role that you are registering with Amazon QuickSight.

• identity_type (pulumi.Input[str]) – Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts either IAM or QUICKSIGHT.

• namespace (pulumi.Input[str]) – The namespace. Currently, you should set this to default.

• session_name (pulumi.Input[str]) – The name of the IAM session to use when assuming roles that can embed QuickSight dashboards.

• user_name (pulumi.Input[str]) – The Amazon QuickSight user name that you want to create for the user you are registering.

• user_role (pulumi.Input[str]) – The Amazon QuickSight role of the user. The user role can be one of the following: READER, AUTHOR, or ADMIN

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str