pulumi-aws-kotlin/com.pulumi.aws.quicksight.kotlin/RoleMembershipArgs

RoleMembershipArgs

data class RoleMembershipArgs(val awsAccountId: Output<String>? = null, val memberName: Output<String>? = null, val namespace: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<RoleMembershipArgs>

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/v6/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
	})
}

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.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 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 aws_account_id, namespace, role, and member_name. For example:

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

Constructors

RoleMembershipArgs

constructor(awsAccountId: Output<String>? = null, memberName: Output<String>? = null, namespace: Output<String>? = null, role: Output<String>? = null)

Properties

awsAccountId

val awsAccountId: Output<String>? = null

AWS account ID. Defaults to the account of the caller identity if not configured.

memberName

val memberName: Output<String>? = null

Name of the group to be added to the role.

namespace

val namespace: Output<String>? = null

Name of the namespace. Defaults to default.

role

val role: Output<String>? = null

Role to add the group to. Valid values are ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, and READER_PRO. The following arguments are optional:

Functions

toJava

open override fun toJava(): RoleMembershipArgs