Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. quicksight
  5. FolderMembership
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.quicksight.FolderMembership

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Resource for managing an AWS QuickSight Folder Membership.

Example Usage

Basic Usage

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

const example = new aws.quicksight.FolderMembership("example", {
    folderId: exampleAwsQuicksightFolder.folderId,
    memberType: "DATASET",
    memberId: exampleAwsQuicksightDataSet.dataSetId,
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.quicksight.FolderMembership("example",
    folder_id=example_aws_quicksight_folder["folderId"],
    member_type="DATASET",
    member_id=example_aws_quicksight_data_set["dataSetId"])
Copy
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.NewFolderMembership(ctx, "example", &quicksight.FolderMembershipArgs{
			FolderId:   pulumi.Any(exampleAwsQuicksightFolder.FolderId),
			MemberType: pulumi.String("DATASET"),
			MemberId:   pulumi.Any(exampleAwsQuicksightDataSet.DataSetId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Quicksight.FolderMembership("example", new()
    {
        FolderId = exampleAwsQuicksightFolder.FolderId,
        MemberType = "DATASET",
        MemberId = exampleAwsQuicksightDataSet.DataSetId,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.FolderMembership;
import com.pulumi.aws.quicksight.FolderMembershipArgs;
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 FolderMembership("example", FolderMembershipArgs.builder()
            .folderId(exampleAwsQuicksightFolder.folderId())
            .memberType("DATASET")
            .memberId(exampleAwsQuicksightDataSet.dataSetId())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:quicksight:FolderMembership
    properties:
      folderId: ${exampleAwsQuicksightFolder.folderId}
      memberType: DATASET
      memberId: ${exampleAwsQuicksightDataSet.dataSetId}
Copy

Create FolderMembership Resource

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

Constructor syntax

new FolderMembership(name: string, args: FolderMembershipArgs, opts?: CustomResourceOptions);
@overload
def FolderMembership(resource_name: str,
                     args: FolderMembershipArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def FolderMembership(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     folder_id: Optional[str] = None,
                     member_id: Optional[str] = None,
                     member_type: Optional[str] = None,
                     aws_account_id: Optional[str] = None)
func NewFolderMembership(ctx *Context, name string, args FolderMembershipArgs, opts ...ResourceOption) (*FolderMembership, error)
public FolderMembership(string name, FolderMembershipArgs args, CustomResourceOptions? opts = null)
public FolderMembership(String name, FolderMembershipArgs args)
public FolderMembership(String name, FolderMembershipArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. FolderMembershipArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. FolderMembershipArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. FolderMembershipArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. FolderMembershipArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. FolderMembershipArgs
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.

var folderMembershipResource = new Aws.Quicksight.FolderMembership("folderMembershipResource", new()
{
    FolderId = "string",
    MemberId = "string",
    MemberType = "string",
    AwsAccountId = "string",
});
Copy
example, err := quicksight.NewFolderMembership(ctx, "folderMembershipResource", &quicksight.FolderMembershipArgs{
	FolderId:     pulumi.String("string"),
	MemberId:     pulumi.String("string"),
	MemberType:   pulumi.String("string"),
	AwsAccountId: pulumi.String("string"),
})
Copy
var folderMembershipResource = new FolderMembership("folderMembershipResource", FolderMembershipArgs.builder()
    .folderId("string")
    .memberId("string")
    .memberType("string")
    .awsAccountId("string")
    .build());
Copy
folder_membership_resource = aws.quicksight.FolderMembership("folderMembershipResource",
    folder_id="string",
    member_id="string",
    member_type="string",
    aws_account_id="string")
Copy
const folderMembershipResource = new aws.quicksight.FolderMembership("folderMembershipResource", {
    folderId: "string",
    memberId: "string",
    memberType: "string",
    awsAccountId: "string",
});
Copy
type: aws:quicksight:FolderMembership
properties:
    awsAccountId: string
    folderId: string
    memberId: string
    memberType: string
Copy

FolderMembership 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 FolderMembership resource accepts the following input properties:

FolderId This property is required. string
Identifier for the folder.
MemberId This property is required. string
ID of the asset (the dashboard, analysis, or dataset).
MemberType This property is required. string

Type of the member. Valid values are ANALYSIS, DASHBOARD, and DATASET.

The following arguments are optional:

AwsAccountId string
AWS account ID.
FolderId This property is required. string
Identifier for the folder.
MemberId This property is required. string
ID of the asset (the dashboard, analysis, or dataset).
MemberType This property is required. string

Type of the member. Valid values are ANALYSIS, DASHBOARD, and DATASET.

The following arguments are optional:

AwsAccountId string
AWS account ID.
folderId This property is required. String
Identifier for the folder.
memberId This property is required. String
ID of the asset (the dashboard, analysis, or dataset).
memberType This property is required. String

Type of the member. Valid values are ANALYSIS, DASHBOARD, and DATASET.

The following arguments are optional:

awsAccountId String
AWS account ID.
folderId This property is required. string
Identifier for the folder.
memberId This property is required. string
ID of the asset (the dashboard, analysis, or dataset).
memberType This property is required. string

Type of the member. Valid values are ANALYSIS, DASHBOARD, and DATASET.

The following arguments are optional:

awsAccountId string
AWS account ID.
folder_id This property is required. str
Identifier for the folder.
member_id This property is required. str
ID of the asset (the dashboard, analysis, or dataset).
member_type This property is required. str

Type of the member. Valid values are ANALYSIS, DASHBOARD, and DATASET.

The following arguments are optional:

aws_account_id str
AWS account ID.
folderId This property is required. String
Identifier for the folder.
memberId This property is required. String
ID of the asset (the dashboard, analysis, or dataset).
memberType This property is required. String

Type of the member. Valid values are ANALYSIS, DASHBOARD, and DATASET.

The following arguments are optional:

awsAccountId String
AWS account ID.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing FolderMembership Resource

Get an existing FolderMembership 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?: FolderMembershipState, opts?: CustomResourceOptions): FolderMembership
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws_account_id: Optional[str] = None,
        folder_id: Optional[str] = None,
        member_id: Optional[str] = None,
        member_type: Optional[str] = None) -> FolderMembership
func GetFolderMembership(ctx *Context, name string, id IDInput, state *FolderMembershipState, opts ...ResourceOption) (*FolderMembership, error)
public static FolderMembership Get(string name, Input<string> id, FolderMembershipState? state, CustomResourceOptions? opts = null)
public static FolderMembership get(String name, Output<String> id, FolderMembershipState state, CustomResourceOptions options)
resources:  _:    type: aws:quicksight:FolderMembership    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AwsAccountId string
AWS account ID.
FolderId string
Identifier for the folder.
MemberId string
ID of the asset (the dashboard, analysis, or dataset).
MemberType string

Type of the member. Valid values are ANALYSIS, DASHBOARD, and DATASET.

The following arguments are optional:

AwsAccountId string
AWS account ID.
FolderId string
Identifier for the folder.
MemberId string
ID of the asset (the dashboard, analysis, or dataset).
MemberType string

Type of the member. Valid values are ANALYSIS, DASHBOARD, and DATASET.

The following arguments are optional:

awsAccountId String
AWS account ID.
folderId String
Identifier for the folder.
memberId String
ID of the asset (the dashboard, analysis, or dataset).
memberType String

Type of the member. Valid values are ANALYSIS, DASHBOARD, and DATASET.

The following arguments are optional:

awsAccountId string
AWS account ID.
folderId string
Identifier for the folder.
memberId string
ID of the asset (the dashboard, analysis, or dataset).
memberType string

Type of the member. Valid values are ANALYSIS, DASHBOARD, and DATASET.

The following arguments are optional:

aws_account_id str
AWS account ID.
folder_id str
Identifier for the folder.
member_id str
ID of the asset (the dashboard, analysis, or dataset).
member_type str

Type of the member. Valid values are ANALYSIS, DASHBOARD, and DATASET.

The following arguments are optional:

awsAccountId String
AWS account ID.
folderId String
Identifier for the folder.
memberId String
ID of the asset (the dashboard, analysis, or dataset).
memberType String

Type of the member. Valid values are ANALYSIS, DASHBOARD, and DATASET.

The following arguments are optional:

Import

Using pulumi import, import QuickSight Folder Membership using the AWS account ID, folder ID, member type, and member ID separated by commas (,). For example:

$ pulumi import aws:quicksight/folderMembership:FolderMembership example 123456789012,example-folder,DATASET,example-dataset
Copy

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.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws