1. Packages
  2. AWS
  3. API Docs
  4. memorydb
  5. getUser
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.memorydb.getUser

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Provides information about a MemoryDB User.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.memorydb.getUser({
        userName: "my-user",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.memorydb.get_user(user_name="my-user")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/memorydb"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := memorydb.LookupUser(ctx, &memorydb.LookupUserArgs{
    			UserName: "my-user",
    		}, nil)
    		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 = Aws.MemoryDb.GetUser.Invoke(new()
        {
            UserName = "my-user",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.memorydb.MemorydbFunctions;
    import com.pulumi.aws.memorydb.inputs.GetUserArgs;
    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 = MemorydbFunctions.getUser(GetUserArgs.builder()
                .userName("my-user")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: aws:memorydb:getUser
          Arguments:
            userName: my-user
    

    Using getUser

    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 getUser(args: GetUserArgs, opts?: InvokeOptions): Promise<GetUserResult>
    function getUserOutput(args: GetUserOutputArgs, opts?: InvokeOptions): Output<GetUserResult>
    def get_user(tags: Optional[Mapping[str, str]] = None,
                 user_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetUserResult
    def get_user_output(tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                 user_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetUserResult]
    func LookupUser(ctx *Context, args *LookupUserArgs, opts ...InvokeOption) (*LookupUserResult, error)
    func LookupUserOutput(ctx *Context, args *LookupUserOutputArgs, opts ...InvokeOption) LookupUserResultOutput

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

    public static class GetUser 
    {
        public static Task<GetUserResult> InvokeAsync(GetUserArgs args, InvokeOptions? opts = null)
        public static Output<GetUserResult> Invoke(GetUserInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:memorydb/getUser:getUser
      arguments:
        # arguments dictionary

    The following arguments are supported:

    UserName string
    Name of the user.
    Tags Dictionary<string, string>
    Map of tags assigned to the user.
    UserName string
    Name of the user.
    Tags map[string]string
    Map of tags assigned to the user.
    userName String
    Name of the user.
    tags Map<String,String>
    Map of tags assigned to the user.
    userName string
    Name of the user.
    tags {[key: string]: string}
    Map of tags assigned to the user.
    user_name str
    Name of the user.
    tags Mapping[str, str]
    Map of tags assigned to the user.
    userName String
    Name of the user.
    tags Map<String>
    Map of tags assigned to the user.

    getUser Result

    The following output properties are available:

    AccessString string
    Access permissions string used for this user.
    Arn string
    ARN of the user.
    AuthenticationModes List<GetUserAuthenticationMode>
    Denotes the user's authentication properties.
    Id string
    The provider-assigned unique ID for this managed resource.
    MinimumEngineVersion string
    Minimum engine version supported for the user.
    Tags Dictionary<string, string>
    Map of tags assigned to the user.
    UserName string
    AccessString string
    Access permissions string used for this user.
    Arn string
    ARN of the user.
    AuthenticationModes []GetUserAuthenticationMode
    Denotes the user's authentication properties.
    Id string
    The provider-assigned unique ID for this managed resource.
    MinimumEngineVersion string
    Minimum engine version supported for the user.
    Tags map[string]string
    Map of tags assigned to the user.
    UserName string
    accessString String
    Access permissions string used for this user.
    arn String
    ARN of the user.
    authenticationModes List<GetUserAuthenticationMode>
    Denotes the user's authentication properties.
    id String
    The provider-assigned unique ID for this managed resource.
    minimumEngineVersion String
    Minimum engine version supported for the user.
    tags Map<String,String>
    Map of tags assigned to the user.
    userName String
    accessString string
    Access permissions string used for this user.
    arn string
    ARN of the user.
    authenticationModes GetUserAuthenticationMode[]
    Denotes the user's authentication properties.
    id string
    The provider-assigned unique ID for this managed resource.
    minimumEngineVersion string
    Minimum engine version supported for the user.
    tags {[key: string]: string}
    Map of tags assigned to the user.
    userName string
    access_string str
    Access permissions string used for this user.
    arn str
    ARN of the user.
    authentication_modes Sequence[GetUserAuthenticationMode]
    Denotes the user's authentication properties.
    id str
    The provider-assigned unique ID for this managed resource.
    minimum_engine_version str
    Minimum engine version supported for the user.
    tags Mapping[str, str]
    Map of tags assigned to the user.
    user_name str
    accessString String
    Access permissions string used for this user.
    arn String
    ARN of the user.
    authenticationModes List<Property Map>
    Denotes the user's authentication properties.
    id String
    The provider-assigned unique ID for this managed resource.
    minimumEngineVersion String
    Minimum engine version supported for the user.
    tags Map<String>
    Map of tags assigned to the user.
    userName String

    Supporting Types

    GetUserAuthenticationMode

    PasswordCount int
    Number of passwords belonging to the user if type is set to password.
    Type string
    Type of authentication configured.
    PasswordCount int
    Number of passwords belonging to the user if type is set to password.
    Type string
    Type of authentication configured.
    passwordCount Integer
    Number of passwords belonging to the user if type is set to password.
    type String
    Type of authentication configured.
    passwordCount number
    Number of passwords belonging to the user if type is set to password.
    type string
    Type of authentication configured.
    password_count int
    Number of passwords belonging to the user if type is set to password.
    type str
    Type of authentication configured.
    passwordCount Number
    Number of passwords belonging to the user if type is set to password.
    type String
    Type of authentication configured.

    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 v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi