1. Packages
  2. AWS Classic
  3. API Docs
  4. quicksight
  5. getQuicksightUser

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.24.0 published on Tuesday, Feb 27, 2024 by Pulumi

aws.quicksight.getQuicksightUser

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.24.0 published on Tuesday, Feb 27, 2024 by Pulumi

    This data source can be used to fetch information about a specific QuickSight user. By using this data source, you can reference QuickSight user properties without having to hard code ARNs or unique IDs as input.

    Example Usage

    Basic Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Aws.Quicksight.GetQuicksightUser.Invoke(new()
        {
            UserName = "example",
        });
    
    });
    
    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.GetQuicksightUser(ctx, &quicksight.GetQuicksightUserArgs{
    			UserName: "example",
    		}, nil)
    		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.QuicksightFunctions;
    import com.pulumi.aws.quicksight.inputs.GetQuicksightUserArgs;
    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) {
            final var example = QuicksightFunctions.getQuicksightUser(GetQuicksightUserArgs.builder()
                .userName("example")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.quicksight.get_quicksight_user(user_name="example")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.quicksight.getQuicksightUser({
        userName: "example",
    });
    
    variables:
      example:
        fn::invoke:
          Function: aws:quicksight:getQuicksightUser
          Arguments:
            userName: example
    

    Using getQuicksightUser

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getQuicksightUser(args: GetQuicksightUserArgs, opts?: InvokeOptions): Promise<GetQuicksightUserResult>
    function getQuicksightUserOutput(args: GetQuicksightUserOutputArgs, opts?: InvokeOptions): Output<GetQuicksightUserResult>
    def get_quicksight_user(aws_account_id: Optional[str] = None,
                            namespace: Optional[str] = None,
                            user_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetQuicksightUserResult
    def get_quicksight_user_output(aws_account_id: Optional[pulumi.Input[str]] = None,
                            namespace: Optional[pulumi.Input[str]] = None,
                            user_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetQuicksightUserResult]
    func GetQuicksightUser(ctx *Context, args *GetQuicksightUserArgs, opts ...InvokeOption) (*GetQuicksightUserResult, error)
    func GetQuicksightUserOutput(ctx *Context, args *GetQuicksightUserOutputArgs, opts ...InvokeOption) GetQuicksightUserResultOutput

    > Note: This function is named GetQuicksightUser in the Go SDK.

    public static class GetQuicksightUser 
    {
        public static Task<GetQuicksightUserResult> InvokeAsync(GetQuicksightUserArgs args, InvokeOptions? opts = null)
        public static Output<GetQuicksightUserResult> Invoke(GetQuicksightUserInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetQuicksightUserResult> getQuicksightUser(GetQuicksightUserArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:quicksight/getQuicksightUser:getQuicksightUser
      arguments:
        # arguments dictionary

    The following arguments are supported:

    UserName string

    The name of the user that you want to match.

    The following arguments are optional:

    AwsAccountId string
    AWS account ID.
    Namespace string
    QuickSight namespace. Defaults to default.
    UserName string

    The name of the user that you want to match.

    The following arguments are optional:

    AwsAccountId string
    AWS account ID.
    Namespace string
    QuickSight namespace. Defaults to default.
    userName String

    The name of the user that you want to match.

    The following arguments are optional:

    awsAccountId String
    AWS account ID.
    namespace String
    QuickSight namespace. Defaults to default.
    userName string

    The name of the user that you want to match.

    The following arguments are optional:

    awsAccountId string
    AWS account ID.
    namespace string
    QuickSight namespace. Defaults to default.
    user_name str

    The name of the user that you want to match.

    The following arguments are optional:

    aws_account_id str
    AWS account ID.
    namespace str
    QuickSight namespace. Defaults to default.
    userName String

    The name of the user that you want to match.

    The following arguments are optional:

    awsAccountId String
    AWS account ID.
    namespace String
    QuickSight namespace. Defaults to default.

    getQuicksightUser Result

    The following output properties are available:

    Active bool
    The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
    Arn string
    The Amazon Resource Name (ARN) for the user.
    AwsAccountId string
    Email string
    The user's email address.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityType string
    The type of identity authentication used by the user.
    PrincipalId string
    The principal ID of the user.
    UserName string
    UserRole string
    The Amazon QuickSight role for the user. The user role can be one of the following:.
    Namespace string
    Active bool
    The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
    Arn string
    The Amazon Resource Name (ARN) for the user.
    AwsAccountId string
    Email string
    The user's email address.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityType string
    The type of identity authentication used by the user.
    PrincipalId string
    The principal ID of the user.
    UserName string
    UserRole string
    The Amazon QuickSight role for the user. The user role can be one of the following:.
    Namespace string
    active Boolean
    The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
    arn String
    The Amazon Resource Name (ARN) for the user.
    awsAccountId String
    email String
    The user's email address.
    id String
    The provider-assigned unique ID for this managed resource.
    identityType String
    The type of identity authentication used by the user.
    principalId String
    The principal ID of the user.
    userName String
    userRole String
    The Amazon QuickSight role for the user. The user role can be one of the following:.
    namespace String
    active boolean
    The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
    arn string
    The Amazon Resource Name (ARN) for the user.
    awsAccountId string
    email string
    The user's email address.
    id string
    The provider-assigned unique ID for this managed resource.
    identityType string
    The type of identity authentication used by the user.
    principalId string
    The principal ID of the user.
    userName string
    userRole string
    The Amazon QuickSight role for the user. The user role can be one of the following:.
    namespace string
    active bool
    The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
    arn str
    The Amazon Resource Name (ARN) for the user.
    aws_account_id str
    email str
    The user's email address.
    id str
    The provider-assigned unique ID for this managed resource.
    identity_type str
    The type of identity authentication used by the user.
    principal_id str
    The principal ID of the user.
    user_name str
    user_role str
    The Amazon QuickSight role for the user. The user role can be one of the following:.
    namespace str
    active Boolean
    The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
    arn String
    The Amazon Resource Name (ARN) for the user.
    awsAccountId String
    email String
    The user's email address.
    id String
    The provider-assigned unique ID for this managed resource.
    identityType String
    The type of identity authentication used by the user.
    principalId String
    The principal ID of the user.
    userName String
    userRole String
    The Amazon QuickSight role for the user. The user role can be one of the following:.
    namespace String

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.24.0 published on Tuesday, Feb 27, 2024 by Pulumi