AWS v6.77.0, Apr 9 25

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

aws.quicksight.GroupMembership

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const example = new aws.quicksight.GroupMembership("example", {
    groupName: "all-access-users",
    memberName: "john_smith",
});

import pulumi
import pulumi_aws as aws

example = aws.quicksight.GroupMembership("example",
    group_name="all-access-users",
    member_name="john_smith")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := quicksight.NewGroupMembership(ctx, "example", &quicksight.GroupMembershipArgs{
			GroupName:  pulumi.String("all-access-users"),
			MemberName: pulumi.String("john_smith"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Quicksight.GroupMembership("example", new()
    {
        GroupName = "all-access-users",
        MemberName = "john_smith",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.GroupMembership;
import com.pulumi.aws.quicksight.GroupMembershipArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new GroupMembership("example", GroupMembershipArgs.builder()
            .groupName("all-access-users")
            .memberName("john_smith")
            .build());

    }
}

resources:
  example:
    type: aws:quicksight:GroupMembership
    properties:
      groupName: all-access-users
      memberName: john_smith

Create GroupMembership Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

new GroupMembership(name: string, args: GroupMembershipArgs, opts?: CustomResourceOptions);

@overload
def GroupMembership(resource_name: str,
                    args: GroupMembershipArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def GroupMembership(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    group_name: Optional[str] = None,
                    member_name: Optional[str] = None,
                    aws_account_id: Optional[str] = None,
                    namespace: Optional[str] = None)

func NewGroupMembership(ctx *Context, name string, args GroupMembershipArgs, opts ...ResourceOption) (*GroupMembership, error)

public GroupMembership(string name, GroupMembershipArgs args, CustomResourceOptions? opts = null)

public GroupMembership(String name, GroupMembershipArgs args)
public GroupMembership(String name, GroupMembershipArgs args, CustomResourceOptions options)

type: aws:quicksight:GroupMembership
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

resource_name str: The unique name of the resource.
args GroupMembershipArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

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

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

name String: The unique name of the resource.
args GroupMembershipArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

TypeScript
Python
Go
C#
Java
YAML

var examplegroupMembershipResourceResourceFromQuicksightgroupMembership = new Aws.Quicksight.GroupMembership("examplegroupMembershipResourceResourceFromQuicksightgroupMembership", new()
{
    GroupName = "string",
    MemberName = "string",
    AwsAccountId = "string",
    Namespace = "string",
});

example, err := quicksight.NewGroupMembership(ctx, "examplegroupMembershipResourceResourceFromQuicksightgroupMembership", &quicksight.GroupMembershipArgs{
	GroupName:    pulumi.String("string"),
	MemberName:   pulumi.String("string"),
	AwsAccountId: pulumi.String("string"),
	Namespace:    pulumi.String("string"),
})

var examplegroupMembershipResourceResourceFromQuicksightgroupMembership = new GroupMembership("examplegroupMembershipResourceResourceFromQuicksightgroupMembership", GroupMembershipArgs.builder()
    .groupName("string")
    .memberName("string")
    .awsAccountId("string")
    .namespace("string")
    .build());

examplegroup_membership_resource_resource_from_quicksightgroup_membership = aws.quicksight.GroupMembership("examplegroupMembershipResourceResourceFromQuicksightgroupMembership",
    group_name="string",
    member_name="string",
    aws_account_id="string",
    namespace="string")

const examplegroupMembershipResourceResourceFromQuicksightgroupMembership = new aws.quicksight.GroupMembership("examplegroupMembershipResourceResourceFromQuicksightgroupMembership", {
    groupName: "string",
    memberName: "string",
    awsAccountId: "string",
    namespace: "string",
});

type: aws:quicksight:GroupMembership
properties:
    awsAccountId: string
    groupName: string
    memberName: string
    namespace: string

GroupMembership Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The GroupMembership resource accepts the following input properties:

GroupName string: The name of the group in which the member will be added.
MemberName string: The name of the member to add to 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.
Namespace string: The namespace that you want the user to be a part of. Defaults to default.

GroupName string: The name of the group in which the member will be added.
MemberName string: The name of the member to add to 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.
Namespace string: The namespace that you want the user to be a part of. Defaults to default.

groupName String: The name of the group in which the member will be added.
memberName String: The name of the member to add to 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.
namespace String: The namespace that you want the user to be a part of. Defaults to default.

groupName string: The name of the group in which the member will be added.
memberName string: The name of the member to add to 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.
namespace string: The namespace that you want the user to be a part of. Defaults to default.

group_name str: The name of the group in which the member will be added.
member_name str: The name of the member to add to 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.
namespace str: The namespace that you want the user to be a part of. Defaults to default.

groupName String: The name of the group in which the member will be added.
memberName String: The name of the member to add to 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.
namespace String: The namespace that you want the user to be a part of. Defaults to default.

Outputs

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

Arn string
Id string: The provider-assigned unique ID for this managed resource.

Arn string
Id string: The provider-assigned unique ID for this managed resource.

arn String
id String: The provider-assigned unique ID for this managed resource.

arn string
id string: The provider-assigned unique ID for this managed resource.

arn str
id str: The provider-assigned unique ID for this managed resource.

arn String
id String: The provider-assigned unique ID for this managed resource.

Look up Existing GroupMembership Resource

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

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: GroupMembershipState, opts?: CustomResourceOptions): GroupMembership

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        aws_account_id: Optional[str] = None,
        group_name: Optional[str] = None,
        member_name: Optional[str] = None,
        namespace: Optional[str] = None) -> GroupMembership

func GetGroupMembership(ctx *Context, name string, id IDInput, state *GroupMembershipState, opts ...ResourceOption) (*GroupMembership, error)

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

public static GroupMembership get(String name, Output<String> id, GroupMembershipState state, CustomResourceOptions options)

resources:  _:    type: aws:quicksight:GroupMembership    get:      id: ${id}

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.

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
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.
GroupName string: The name of the group in which the member will be added.
MemberName string: The name of the member to add to the group.
Namespace string: The namespace that you want the user to be a part of. Defaults to default.

Arn string
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.
GroupName string: The name of the group in which the member will be added.
MemberName string: The name of the member to add to the group.
Namespace string: The namespace that you want the user to be a part of. Defaults to default.

arn String
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.
groupName String: The name of the group in which the member will be added.
memberName String: The name of the member to add to the group.
namespace String: The namespace that you want the user to be a part of. Defaults to default.

arn string
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.
groupName string: The name of the group in which the member will be added.
memberName string: The name of the member to add to the group.
namespace string: The namespace that you want the user to be a part of. Defaults to default.

arn str
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.
group_name str: The name of the group in which the member will be added.
member_name str: The name of the member to add to the group.
namespace str: The namespace that you want the user to be a part of. Defaults to default.

arn String
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.
groupName String: The name of the group in which the member will be added.
memberName String: The name of the member to add to the group.
namespace String: The namespace that you want the user to be a part of. Defaults to default.

Import

Using pulumi import, import QuickSight Group membership using the AWS account ID, namespace, group name and member name separated by /. For example:

$ pulumi import aws:quicksight/groupMembership:GroupMembership example 123456789123/default/all-access-users/john_smith

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

pulumi/pulumi-aws

aws.quicksight.GroupMembership

On this page

On this page

Example Usage

Create GroupMembership Resource

Constructor syntax

Parameters

Constructor example

GroupMembership Resource Properties

Inputs

Outputs

Look up Existing GroupMembership Resource

Import

Package Details

On this page

On this page