FolderMembership class

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"])
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 main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_quicksight_foldermembership" "example" {
  folder_id   = exampleAwsQuicksightFolder.folderId
  member_type = "DATASET"
  member_id   = 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.ArrayList;
import java.util.Arrays;
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}

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

Constructors

FolderMembership(String name, {FolderMembershipArgs? args, CustomResourceOptions? options})
Creates a new FolderMembership. name The Pulumi resource name. args Arguments used to configure this FolderMembership. The set of arguments for FolderMembership. options Resource options controlling this resource's behavior.
FolderMembership.reference(String urn)
Creates a typed reference to an existing FolderMembership resource.

Properties

awsAccountId ↔ Output<String>
AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
folderId ↔ Output<String>
Identifier for the folder.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
memberId ↔ Output<String>
ID of the asset (the dashboard, analysis, or dataset).
latefinal
memberType ↔ Output<String>
Type of the member. Valid values are ANALYSIS, DASHBOARD, and DATASET.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {FolderMembershipState? state, CustomResourceOptions? options}) → FolderMembership
Gets an existing FolderMembership resource's state with the given name and id.