1. Packages
  2. AWS Classic
  3. API Docs
  4. quicksight
  5. FolderMembership

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.0 published on Monday, Apr 15, 2024 by Pulumi

aws.quicksight.FolderMembership

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.0 published on Monday, Apr 15, 2024 by Pulumi

    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,
    });
    
    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"])
    
    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
    	})
    }
    
    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,
        });
    
    });
    
    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());
    
        }
    }
    
    resources:
      example:
        type: aws:quicksight:FolderMembership
        properties:
          folderId: ${exampleAwsQuicksightFolder.folderId}
          memberType: DATASET
          memberId: ${exampleAwsQuicksightDataSet.dataSetId}
    

    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 string
    The unique name of the resource.
    args FolderMembershipArgs
    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 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 string
    The unique name of the resource.
    args FolderMembershipArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FolderMembershipArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FolderMembershipArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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",
    });
    
    example, err := quicksight.NewFolderMembership(ctx, "folderMembershipResource", &quicksight.FolderMembershipArgs{
    	FolderId:     pulumi.String("string"),
    	MemberId:     pulumi.String("string"),
    	MemberType:   pulumi.String("string"),
    	AwsAccountId: pulumi.String("string"),
    })
    
    var folderMembershipResource = new FolderMembership("folderMembershipResource", FolderMembershipArgs.builder()        
        .folderId("string")
        .memberId("string")
        .memberType("string")
        .awsAccountId("string")
        .build());
    
    folder_membership_resource = aws.quicksight.FolderMembership("folderMembershipResource",
        folder_id="string",
        member_id="string",
        member_type="string",
        aws_account_id="string")
    
    const folderMembershipResource = new aws.quicksight.FolderMembership("folderMembershipResource", {
        folderId: "string",
        memberId: "string",
        memberType: "string",
        awsAccountId: "string",
    });
    
    type: aws:quicksight:FolderMembership
    properties:
        awsAccountId: string
        folderId: string
        memberId: string
        memberType: string
    

    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

    The FolderMembership resource accepts the following input properties:

    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:

    awsAccountId string
    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:

    aws_account_id str
    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.

    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)
    Resource lookup is not supported in YAML
    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:
    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
    

    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 logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.31.0 published on Monday, Apr 15, 2024 by Pulumi