RoleMembership class

Resource for managing an AWS QuickSight Role Membership.

> The role membership APIs are disabled for identities managed by QuickSight. This resource can only be used when the QuickSight account subscription uses the Active Directory or IAM Identity Center authentication method.

Example Usage

Basic Usage

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

const example = new aws.quicksight.RoleMembership("example", {
    memberName: "example-group",
    role: "READER",
});
import pulumi
import pulumi_aws as aws

example = aws.quicksight.RoleMembership("example",
    member_name="example-group",
    role="READER")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Quicksight.RoleMembership("example", new()
    {
        MemberName = "example-group",
        Role = "READER",
    });

});
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.NewRoleMembership(ctx, "example", &quicksight.RoleMembershipArgs{
			MemberName: pulumi.String("example-group"),
			Role:       pulumi.String("READER"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_quicksight_rolemembership" "example" {
  member_name = "example-group"
  role        = "READER"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.RoleMembership;
import com.pulumi.aws.quicksight.RoleMembershipArgs;
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 RoleMembership("example", RoleMembershipArgs.builder()
            .memberName("example-group")
            .role("READER")
            .build());

    }
}
resources:
  example:
    type: aws:quicksight:RoleMembership
    properties:
      memberName: example-group
      role: READER

Import

Using pulumi import, import QuickSight Role Membership using a comma-delimited string combining the awsAccountId, namespace, role, and memberName. For example:

$ pulumi import aws:quicksight/roleMembership:RoleMembership example 012345678901,default,READER,example-group

Constructors

RoleMembership(String name, {RoleMembershipArgs? args, CustomResourceOptions? options})
Creates a new RoleMembership. name The Pulumi resource name. args Arguments used to configure this RoleMembership. The set of arguments for RoleMembership. options Resource options controlling this resource's behavior.
RoleMembership.reference(String urn)
Creates a typed reference to an existing RoleMembership 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
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
memberName ↔ Output<String>
Name of the group to be added to the role.
latefinal
namespace ↔ Output<String>
Name of the namespace. Defaults to default.
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
role ↔ Output<String>
Role to add the group to. Valid values are ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, and READER_PRO.
latefinal
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, {RoleMembershipState? state, CustomResourceOptions? options}) → RoleMembership
Gets an existing RoleMembership resource's state with the given name and id.