Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. quicksight
  5. RoleCustomPermission
AWS v7.7.0 published on Friday, Sep 5, 2025 by Pulumi
pulumi/pulumi-aws

aws.quicksight.RoleCustomPermission

Explore with Pulumi AI

aws logo
AWS v7.7.0 published on Friday, Sep 5, 2025 by Pulumi
pulumi/pulumi-aws

    Manages the custom permissions that are associated with a role.

    Example Usage

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

const example = new aws.quicksight.RoleCustomPermission("example", {
    role: "READER",
    customPermissionsName: exampleAwsQuicksightCustomPermissions.customPermissionsName,
});

    import pulumi
import pulumi_aws as aws

example = aws.quicksight.RoleCustomPermission("example",
    role="READER",
    custom_permissions_name=example_aws_quicksight_custom_permissions["customPermissionsName"])

    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.NewRoleCustomPermission(ctx, "example", &quicksight.RoleCustomPermissionArgs{
			Role:                  pulumi.String("READER"),
			CustomPermissionsName: pulumi.Any(exampleAwsQuicksightCustomPermissions.CustomPermissionsName),
		})
		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.RoleCustomPermission("example", new()
    {
        Role = "READER",
        CustomPermissionsName = exampleAwsQuicksightCustomPermissions.CustomPermissionsName,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.RoleCustomPermission;
import com.pulumi.aws.quicksight.RoleCustomPermissionArgs;
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 RoleCustomPermission("example", RoleCustomPermissionArgs.builder()
            .role("READER")
            .customPermissionsName(exampleAwsQuicksightCustomPermissions.customPermissionsName())
            .build());

    }
}

    resources:
  example:
    type: aws:quicksight:RoleCustomPermission
    properties:
      role: READER
      customPermissionsName: ${exampleAwsQuicksightCustomPermissions.customPermissionsName}

    Create RoleCustomPermission Resource

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

    Constructor syntax

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

@overload
def RoleCustomPermission(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         custom_permissions_name: Optional[str] = None,
                         role: Optional[str] = None,
                         aws_account_id: Optional[str] = None,
                         namespace: Optional[str] = None,
                         region: Optional[str] = None)
    func NewRoleCustomPermission(ctx *Context, name string, args RoleCustomPermissionArgs, opts ...ResourceOption) (*RoleCustomPermission, error)
    public RoleCustomPermission(string name, RoleCustomPermissionArgs args, CustomResourceOptions? opts = null)
    public RoleCustomPermission(String name, RoleCustomPermissionArgs args)
public RoleCustomPermission(String name, RoleCustomPermissionArgs args, CustomResourceOptions options)

    type: aws:quicksight:RoleCustomPermission
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 RoleCustomPermissionArgs
    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 RoleCustomPermissionArgs
    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 RoleCustomPermissionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RoleCustomPermissionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RoleCustomPermissionArgs
    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 roleCustomPermissionResource = new Aws.Quicksight.RoleCustomPermission("roleCustomPermissionResource", new()
{
    CustomPermissionsName = "string",
    Role = "string",
    AwsAccountId = "string",
    Namespace = "string",
    Region = "string",
});

    example, err := quicksight.NewRoleCustomPermission(ctx, "roleCustomPermissionResource", &quicksight.RoleCustomPermissionArgs{
	CustomPermissionsName: pulumi.String("string"),
	Role:                  pulumi.String("string"),
	AwsAccountId:          pulumi.String("string"),
	Namespace:             pulumi.String("string"),
	Region:                pulumi.String("string"),
})

    var roleCustomPermissionResource = new RoleCustomPermission("roleCustomPermissionResource", RoleCustomPermissionArgs.builder()
    .customPermissionsName("string")
    .role("string")
    .awsAccountId("string")
    .namespace("string")
    .region("string")
    .build());

    role_custom_permission_resource = aws.quicksight.RoleCustomPermission("roleCustomPermissionResource",
    custom_permissions_name="string",
    role="string",
    aws_account_id="string",
    namespace="string",
    region="string")

    const roleCustomPermissionResource = new aws.quicksight.RoleCustomPermission("roleCustomPermissionResource", {
    customPermissionsName: "string",
    role: "string",
    awsAccountId: "string",
    namespace: "string",
    region: "string",
});

    type: aws:quicksight:RoleCustomPermission
properties:
    awsAccountId: string
    customPermissionsName: string
    namespace: string
    region: string
    role: string

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

    CustomPermissionsName string
    Custom permissions profile name.
    Role string

    Role. Valid values are ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, and READER_PRO.

    The following arguments are optional:

    AwsAccountId string
    Namespace string
    Namespace containing the role. Defaults to default.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    CustomPermissionsName string
    Custom permissions profile name.
    Role string

    Role. Valid values are ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, and READER_PRO.

    The following arguments are optional:

    AwsAccountId string
    Namespace string
    Namespace containing the role. Defaults to default.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    customPermissionsName String
    Custom permissions profile name.
    role String

    Role. Valid values are ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, and READER_PRO.

    The following arguments are optional:

    awsAccountId String
    namespace String
    Namespace containing the role. Defaults to default.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    customPermissionsName string
    Custom permissions profile name.
    role string

    Role. Valid values are ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, and READER_PRO.

    The following arguments are optional:

    awsAccountId string
    namespace string
    Namespace containing the role. Defaults to default.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    custom_permissions_name str
    Custom permissions profile name.
    role str

    Role. Valid values are ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, and READER_PRO.

    The following arguments are optional:

    aws_account_id str
    namespace str
    Namespace containing the role. Defaults to default.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    customPermissionsName String
    Custom permissions profile name.
    role String

    Role. Valid values are ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, and READER_PRO.

    The following arguments are optional:

    awsAccountId String
    namespace String
    Namespace containing the role. Defaults to default.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RoleCustomPermission 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 RoleCustomPermission Resource

    Get an existing RoleCustomPermission 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?: RoleCustomPermissionState, opts?: CustomResourceOptions): RoleCustomPermission
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws_account_id: Optional[str] = None,
        custom_permissions_name: Optional[str] = None,
        namespace: Optional[str] = None,
        region: Optional[str] = None,
        role: Optional[str] = None) -> RoleCustomPermission
    func GetRoleCustomPermission(ctx *Context, name string, id IDInput, state *RoleCustomPermissionState, opts ...ResourceOption) (*RoleCustomPermission, error)
    public static RoleCustomPermission Get(string name, Input<string> id, RoleCustomPermissionState? state, CustomResourceOptions? opts = null)
    public static RoleCustomPermission get(String name, Output<String> id, RoleCustomPermissionState state, CustomResourceOptions options)
    resources:  _:    type: aws:quicksight:RoleCustomPermission    get:      id: ${id}
    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
    CustomPermissionsName string
    Custom permissions profile name.
    Namespace string
    Namespace containing the role. Defaults to default.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Role string

    Role. Valid values are ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, and READER_PRO.

    The following arguments are optional:

    AwsAccountId string
    CustomPermissionsName string
    Custom permissions profile name.
    Namespace string
    Namespace containing the role. Defaults to default.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Role string

    Role. Valid values are ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, and READER_PRO.

    The following arguments are optional:

    awsAccountId String
    customPermissionsName String
    Custom permissions profile name.
    namespace String
    Namespace containing the role. Defaults to default.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role String

    Role. Valid values are ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, and READER_PRO.

    The following arguments are optional:

    awsAccountId string
    customPermissionsName string
    Custom permissions profile name.
    namespace string
    Namespace containing the role. Defaults to default.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role string

    Role. Valid values are ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, and READER_PRO.

    The following arguments are optional:

    aws_account_id str
    custom_permissions_name str
    Custom permissions profile name.
    namespace str
    Namespace containing the role. Defaults to default.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role str

    Role. Valid values are ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, and READER_PRO.

    The following arguments are optional:

    awsAccountId String
    customPermissionsName String
    Custom permissions profile name.
    namespace String
    Namespace containing the role. Defaults to default.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role String

    Role. Valid values are ADMIN, AUTHOR, READER, ADMIN_PRO, AUTHOR_PRO, and READER_PRO.

    The following arguments are optional:

    Import

    Using pulumi import, import QuickSight role custom permissions using a comma-delimited string combining the aws_account_id, namespace, and role. For example:

    $ pulumi import aws:quicksight/roleCustomPermission:RoleCustomPermission example 012345678901,default,READER

    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
    AWS v7.7.0 published on Friday, Sep 5, 2025 by Pulumi
    pulumi/pulumi-aws