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

aws.quicksight.UserCustomPermission

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 profile for a user.

    Example Usage

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

const example = new aws.quicksight.UserCustomPermission("example", {
    userName: exampleAwsQuicksightUser.userName,
    customPermissionsName: exampleAwsQuicksightCustomPermissions.customPermissionsName,
});

    import pulumi
import pulumi_aws as aws

example = aws.quicksight.UserCustomPermission("example",
    user_name=example_aws_quicksight_user["userName"],
    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.NewUserCustomPermission(ctx, "example", &quicksight.UserCustomPermissionArgs{
			UserName:              pulumi.Any(exampleAwsQuicksightUser.UserName),
			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.UserCustomPermission("example", new()
    {
        UserName = exampleAwsQuicksightUser.UserName,
        CustomPermissionsName = exampleAwsQuicksightCustomPermissions.CustomPermissionsName,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.UserCustomPermission;
import com.pulumi.aws.quicksight.UserCustomPermissionArgs;
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 UserCustomPermission("example", UserCustomPermissionArgs.builder()
            .userName(exampleAwsQuicksightUser.userName())
            .customPermissionsName(exampleAwsQuicksightCustomPermissions.customPermissionsName())
            .build());

    }
}

    resources:
  example:
    type: aws:quicksight:UserCustomPermission
    properties:
      userName: ${exampleAwsQuicksightUser.userName}
      customPermissionsName: ${exampleAwsQuicksightCustomPermissions.customPermissionsName}

    Create UserCustomPermission Resource

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

    Constructor syntax

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

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

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

    example, err := quicksight.NewUserCustomPermission(ctx, "userCustomPermissionResource", &quicksight.UserCustomPermissionArgs{
	CustomPermissionsName: pulumi.String("string"),
	UserName:              pulumi.String("string"),
	AwsAccountId:          pulumi.String("string"),
	Namespace:             pulumi.String("string"),
	Region:                pulumi.String("string"),
})

    var userCustomPermissionResource = new UserCustomPermission("userCustomPermissionResource", UserCustomPermissionArgs.builder()
    .customPermissionsName("string")
    .userName("string")
    .awsAccountId("string")
    .namespace("string")
    .region("string")
    .build());

    user_custom_permission_resource = aws.quicksight.UserCustomPermission("userCustomPermissionResource",
    custom_permissions_name="string",
    user_name="string",
    aws_account_id="string",
    namespace="string",
    region="string")

    const userCustomPermissionResource = new aws.quicksight.UserCustomPermission("userCustomPermissionResource", {
    customPermissionsName: "string",
    userName: "string",
    awsAccountId: "string",
    namespace: "string",
    region: "string",
});

    type: aws:quicksight:UserCustomPermission
properties:
    awsAccountId: string
    customPermissionsName: string
    namespace: string
    region: string
    userName: string

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

    CustomPermissionsName string
    Custom permissions profile name.
    UserName string

    Username of the user.

    The following arguments are optional:

    AwsAccountId string
    Namespace string
    Namespace that the user belongs to. 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.
    UserName string

    Username of the user.

    The following arguments are optional:

    AwsAccountId string
    Namespace string
    Namespace that the user belongs to. 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.
    userName String

    Username of the user.

    The following arguments are optional:

    awsAccountId String
    namespace String
    Namespace that the user belongs to. 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.
    userName string

    Username of the user.

    The following arguments are optional:

    awsAccountId string
    namespace string
    Namespace that the user belongs to. 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.
    user_name str

    Username of the user.

    The following arguments are optional:

    aws_account_id str
    namespace str
    Namespace that the user belongs to. 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.
    userName String

    Username of the user.

    The following arguments are optional:

    awsAccountId String
    namespace String
    Namespace that the user belongs to. 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 UserCustomPermission 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 UserCustomPermission Resource

    Get an existing UserCustomPermission 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?: UserCustomPermissionState, opts?: CustomResourceOptions): UserCustomPermission
    @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,
        user_name: Optional[str] = None) -> UserCustomPermission
    func GetUserCustomPermission(ctx *Context, name string, id IDInput, state *UserCustomPermissionState, opts ...ResourceOption) (*UserCustomPermission, error)
    public static UserCustomPermission Get(string name, Input<string> id, UserCustomPermissionState? state, CustomResourceOptions? opts = null)
    public static UserCustomPermission get(String name, Output<String> id, UserCustomPermissionState state, CustomResourceOptions options)
    resources:  _:    type: aws:quicksight:UserCustomPermission    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 that the user belongs to. Defaults to default.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    UserName string

    Username of the user.

    The following arguments are optional:

    AwsAccountId string
    CustomPermissionsName string
    Custom permissions profile name.
    Namespace string
    Namespace that the user belongs to. Defaults to default.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    UserName string

    Username of the user.

    The following arguments are optional:

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

    Username of the user.

    The following arguments are optional:

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

    Username of the user.

    The following arguments are optional:

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

    Username of the user.

    The following arguments are optional:

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

    Username of the user.

    The following arguments are optional:

    Import

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

    $ pulumi import aws:quicksight/userCustomPermission:UserCustomPermission example 012345678901,default,user1

    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