1. Packages
  2. Snowflake
  3. API Docs
  4. getUsers
Snowflake v0.52.0 published on Thursday, Apr 18, 2024 by Pulumi

snowflake.getUsers

Explore with Pulumi AI

snowflake logo
Snowflake v0.52.0 published on Thursday, Apr 18, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as snowflake from "@pulumi/snowflake";
    
    const current = snowflake.getUsers({
        pattern: "user1",
    });
    
    import pulumi
    import pulumi_snowflake as snowflake
    
    current = snowflake.get_users(pattern="user1")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-snowflake/sdk/go/snowflake"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := snowflake.GetUsers(ctx, &snowflake.GetUsersArgs{
    			Pattern: "user1",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Snowflake = Pulumi.Snowflake;
    
    return await Deployment.RunAsync(() => 
    {
        var current = Snowflake.GetUsers.Invoke(new()
        {
            Pattern = "user1",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.snowflake.SnowflakeFunctions;
    import com.pulumi.snowflake.inputs.GetUsersArgs;
    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 current = SnowflakeFunctions.getUsers(GetUsersArgs.builder()
                .pattern("user1")
                .build());
    
        }
    }
    
    variables:
      current:
        fn::invoke:
          Function: snowflake:getUsers
          Arguments:
            pattern: user1
    

    Using getUsers

    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 getUsers(args: GetUsersArgs, opts?: InvokeOptions): Promise<GetUsersResult>
    function getUsersOutput(args: GetUsersOutputArgs, opts?: InvokeOptions): Output<GetUsersResult>
    def get_users(pattern: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetUsersResult
    def get_users_output(pattern: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetUsersResult]
    func GetUsers(ctx *Context, args *GetUsersArgs, opts ...InvokeOption) (*GetUsersResult, error)
    func GetUsersOutput(ctx *Context, args *GetUsersOutputArgs, opts ...InvokeOption) GetUsersResultOutput

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

    public static class GetUsers 
    {
        public static Task<GetUsersResult> InvokeAsync(GetUsersArgs args, InvokeOptions? opts = null)
        public static Output<GetUsersResult> Invoke(GetUsersInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetUsersResult> getUsers(GetUsersArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: snowflake:index/getUsers:getUsers
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Pattern string
    Users pattern for which to return metadata. Please refer to LIKE keyword from snowflake documentation : https://docs.snowflake.com/en/sql-reference/sql/show-users.html#parameters
    Pattern string
    Users pattern for which to return metadata. Please refer to LIKE keyword from snowflake documentation : https://docs.snowflake.com/en/sql-reference/sql/show-users.html#parameters
    pattern String
    Users pattern for which to return metadata. Please refer to LIKE keyword from snowflake documentation : https://docs.snowflake.com/en/sql-reference/sql/show-users.html#parameters
    pattern string
    Users pattern for which to return metadata. Please refer to LIKE keyword from snowflake documentation : https://docs.snowflake.com/en/sql-reference/sql/show-users.html#parameters
    pattern str
    Users pattern for which to return metadata. Please refer to LIKE keyword from snowflake documentation : https://docs.snowflake.com/en/sql-reference/sql/show-users.html#parameters
    pattern String
    Users pattern for which to return metadata. Please refer to LIKE keyword from snowflake documentation : https://docs.snowflake.com/en/sql-reference/sql/show-users.html#parameters

    getUsers Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Pattern string
    Users pattern for which to return metadata. Please refer to LIKE keyword from snowflake documentation : https://docs.snowflake.com/en/sql-reference/sql/show-users.html#parameters
    Users List<GetUsersUser>
    The users in the database
    Id string
    The provider-assigned unique ID for this managed resource.
    Pattern string
    Users pattern for which to return metadata. Please refer to LIKE keyword from snowflake documentation : https://docs.snowflake.com/en/sql-reference/sql/show-users.html#parameters
    Users []GetUsersUser
    The users in the database
    id String
    The provider-assigned unique ID for this managed resource.
    pattern String
    Users pattern for which to return metadata. Please refer to LIKE keyword from snowflake documentation : https://docs.snowflake.com/en/sql-reference/sql/show-users.html#parameters
    users List<GetUsersUser>
    The users in the database
    id string
    The provider-assigned unique ID for this managed resource.
    pattern string
    Users pattern for which to return metadata. Please refer to LIKE keyword from snowflake documentation : https://docs.snowflake.com/en/sql-reference/sql/show-users.html#parameters
    users GetUsersUser[]
    The users in the database
    id str
    The provider-assigned unique ID for this managed resource.
    pattern str
    Users pattern for which to return metadata. Please refer to LIKE keyword from snowflake documentation : https://docs.snowflake.com/en/sql-reference/sql/show-users.html#parameters
    users Sequence[GetUsersUser]
    The users in the database
    id String
    The provider-assigned unique ID for this managed resource.
    pattern String
    Users pattern for which to return metadata. Please refer to LIKE keyword from snowflake documentation : https://docs.snowflake.com/en/sql-reference/sql/show-users.html#parameters
    users List<Property Map>
    The users in the database

    Supporting Types

    GetUsersUser

    comment String
    defaultNamespace String
    defaultRole String
    defaultSecondaryRoles List<String>
    defaultWarehouse String
    disabled Boolean
    displayName String
    email String
    firstName String
    hasRsaPublicKey Boolean
    lastName String
    loginName String
    name String
    comment string
    defaultNamespace string
    defaultRole string
    defaultSecondaryRoles string[]
    defaultWarehouse string
    disabled boolean
    displayName string
    email string
    firstName string
    hasRsaPublicKey boolean
    lastName string
    loginName string
    name string
    comment String
    defaultNamespace String
    defaultRole String
    defaultSecondaryRoles List<String>
    defaultWarehouse String
    disabled Boolean
    displayName String
    email String
    firstName String
    hasRsaPublicKey Boolean
    lastName String
    loginName String
    name String

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Snowflake v0.52.0 published on Thursday, Apr 18, 2024 by Pulumi