Module quicksight

@pulumi/aws > 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 Group

extends CustomResource

Resource for managing Quick Sight 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",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/quicksight_group.html.markdown.

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): boolean

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.

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

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.