Group

Resource for managing QuickSight Group

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Quicksight.Group("example", new Aws.Quicksight.GroupArgs
        {
            GroupName = "tf-example",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/quicksight"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := quicksight.NewGroup(ctx, "example", &quicksight.GroupArgs{
            GroupName: pulumi.String("tf-example"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

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

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

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

Create a Group Resource

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

def Group(resource_name, opts=None, aws_account_id=None, description=None, group_name=None, namespace=None, __props__=None);

func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)

public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Group Resource Properties

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

Inputs

The Group resource accepts the following input properties:

GroupName string: A name for the group.
AwsAccountId 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.
Description string: A description for the group.
Namespace string: The namespace. Currently, you should set this to default.

GroupName string: A name for the group.
AwsAccountId 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.
Description string: A description for the group.
Namespace string: The namespace. Currently, you should set this to default.

groupName string: A name for the group.
awsAccountId 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.
description string: A description for the group.
namespace string: The namespace. Currently, you should set this to default.

group_name str: A name for the group.
aws_account_id 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 str: A description for the group.
namespace str: The namespace. Currently, you should set this to default.

Outputs

All input properties are implicitly available as output properties. Additionally, the Group resource produces the following output properties:

Arn string: Amazon Resource Name (ARN) of group
Id string: The provider-assigned unique ID for this managed resource.

Arn string: Amazon Resource Name (ARN) of group
Id string: The provider-assigned unique ID for this managed resource.

arn string: Amazon Resource Name (ARN) of group
id string: The provider-assigned unique ID for this managed resource.

arn str: Amazon Resource Name (ARN) of group
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Group Resource

Get an existing Group 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?: GroupState, opts?: CustomResourceOptions): Group

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

func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)

public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

Arn string: Amazon Resource Name (ARN) of group
AwsAccountId 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.
Description string: A description for the group.
GroupName string: A name for the group.
Namespace string: The namespace. Currently, you should set this to default.

Arn string: Amazon Resource Name (ARN) of group
AwsAccountId 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.
Description string: A description for the group.
GroupName string: A name for the group.
Namespace string: The namespace. Currently, you should set this to default.

arn string: Amazon Resource Name (ARN) of group
awsAccountId 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.
description string: A description for the group.
groupName string: A name for the group.
namespace string: The namespace. Currently, you should set this to default.

arn str: Amazon Resource Name (ARN) of group
aws_account_id 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 str: A description for the group.
group_name str: A name for the group.
namespace str: The namespace. Currently, you should set this to default.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud