Snowflake v0.55.0 published on Friday, Jun 7, 2024 by Pulumi
snowflake.getUsers
Explore with Pulumi AI
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 dictionaryThe 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<Get
Users User>  - 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
[]Get
Users User  - 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<Get
Users User>  - 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
Get
Users User[]  - 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[Get
Users User]  - 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
 - Default
Namespace string - Default
Role string - Default
Secondary List<string>Roles  - Default
Warehouse string - Disabled bool
 - Display
Name string - Email string
 - First
Name string - Has
Rsa boolPublic Key  - Last
Name string - Login
Name string - Name string
 
- Comment string
 - Default
Namespace string - Default
Role string - Default
Secondary []stringRoles  - Default
Warehouse string - Disabled bool
 - Display
Name string - Email string
 - First
Name string - Has
Rsa boolPublic Key  - Last
Name string - Login
Name string - Name string
 
- comment String
 - default
Namespace String - default
Role String - default
Secondary List<String>Roles  - default
Warehouse String - disabled Boolean
 - display
Name String - email String
 - first
Name String - has
Rsa BooleanPublic Key  - last
Name String - login
Name String - name String
 
- comment string
 - default
Namespace string - default
Role string - default
Secondary string[]Roles  - default
Warehouse string - disabled boolean
 - display
Name string - email string
 - first
Name string - has
Rsa booleanPublic Key  - last
Name string - login
Name string - name string
 
- comment str
 - default_
namespace str - default_
role str - default_
secondary_ Sequence[str]roles  - default_
warehouse str - disabled bool
 - display_
name str - email str
 - first_
name str - has_
rsa_ boolpublic_ key  - last_
name str - login_
name str - name str
 
- comment String
 - default
Namespace String - default
Role String - default
Secondary List<String>Roles  - default
Warehouse String - disabled Boolean
 - display
Name String - email String
 - first
Name String - has
Rsa BooleanPublic Key  - last
Name String - login
Name String - name String
 
Package Details
- Repository
 - Snowflake pulumi/pulumi-snowflake
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
snowflakeTerraform Provider.