1. Packages
  2. Astra DB
  3. API Docs
  4. getUsers
Astra DB v1.0.42 published on Tuesday, Jun 6, 2023 by pulumiverse

astra.getUsers

Explore with Pulumi AI

Astra DB v1.0.42 published on Tuesday, Jun 6, 2023 by pulumiverse

astra.getUsers provides a datasource for a list of Astra users. This can be used to select users within your Astra Organization.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Astra = Pulumi.Astra;

return await Deployment.RunAsync(() => 
{
    var dev = Astra.GetUsers.Invoke();

});
Copy
package main

import (
	"github.com/pulumi/pulumi-astra/sdk/go/astra"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-astra/sdk/go/astra"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := astra.GetUsers(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.astra.AstraFunctions;
import com.pulumi.astra.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 dev = AstraFunctions.getUsers();

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as astra from "@pulumi/astra";

const dev = pulumi.output(astra.getUsers());
Copy
import pulumi
import pulumi_astra as astra

dev = astra.get_users()
Copy
variables:
  dev:
    Fn::Invoke:
      Function: astra:getUsers
      Arguments: {}
Copy

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

> 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)
}
Copy
public static CompletableFuture<GetUsersResult> getUsers(GetUsersArgs args, InvokeOptions options)
public static Output<GetUsersResult> getUsers(GetUsersArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: astra:index/getUsers:getUsers
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

OrgName string
Organization Name.
OrgName string
Organization Name.
orgName String
Organization Name.
orgName string
Organization Name.
org_name str
Organization Name.
orgName String
Organization Name.

getUsers Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
OrgId string
Organization ID.
Users List<Pulumiverse.Astra.Outputs.GetUsersUser>
The list of Astra users.
OrgName string
Organization Name.
Id string
The provider-assigned unique ID for this managed resource.
OrgId string
Organization ID.
Users []GetUsersUser
The list of Astra users.
OrgName string
Organization Name.
id String
The provider-assigned unique ID for this managed resource.
orgId String
Organization ID.
users List<GetUsersUser>
The list of Astra users.
orgName String
Organization Name.
id string
The provider-assigned unique ID for this managed resource.
orgId string
Organization ID.
users GetUsersUser[]
The list of Astra users.
orgName string
Organization Name.
id str
The provider-assigned unique ID for this managed resource.
org_id str
Organization ID.
users Sequence[GetUsersUser]
The list of Astra users.
org_name str
Organization Name.
id String
The provider-assigned unique ID for this managed resource.
orgId String
Organization ID.
users List<Property Map>
The list of Astra users.
orgName String
Organization Name.

Supporting Types

GetUsersUser

Email This property is required. string
Roles This property is required. List<Pulumiverse.Astra.Inputs.GetUsersUserRole>
Status This property is required. string
UserId This property is required. string
Email This property is required. string
Roles This property is required. []GetUsersUserRole
Status This property is required. string
UserId This property is required. string
email This property is required. String
roles This property is required. List<GetUsersUserRole>
status This property is required. String
userId This property is required. String
email This property is required. string
roles This property is required. GetUsersUserRole[]
status This property is required. string
userId This property is required. string
email This property is required. str
roles This property is required. Sequence[GetUsersUserRole]
status This property is required. str
user_id This property is required. str
email This property is required. String
roles This property is required. List<Property Map>
status This property is required. String
userId This property is required. String

GetUsersUserRole

RoleId This property is required. string
RoleId This property is required. string
roleId This property is required. String
roleId This property is required. string
role_id This property is required. str
roleId This property is required. String

Package Details

Repository
astra pulumiverse/pulumi-astra
License
Apache-2.0
Notes
This Pulumi package is based on the astra Terraform Provider.
Astra DB v1.0.42 published on Tuesday, Jun 6, 2023 by pulumiverse