Volcengine v0.0.24 published on Tuesday, Jun 25, 2024 by Volcengine
volcengine.iam.Users
Explore with Pulumi AI
Use this data source to query detailed information of iam users
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;
return await Deployment.RunAsync(() =>
{
var fooUser = new Volcengine.Iam.User("fooUser", new()
{
UserName = "acc-test-user",
Description = "acc test",
DisplayName = "name",
});
var fooUsers = Volcengine.Iam.Users.Invoke(new()
{
UserNames = new[]
{
fooUser.UserName,
},
});
});
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/iam"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
fooUser, err := iam.NewUser(ctx, "fooUser", &iam.UserArgs{
UserName: pulumi.String("acc-test-user"),
Description: pulumi.String("acc test"),
DisplayName: pulumi.String("name"),
})
if err != nil {
return err
}
_ = iam.UsersOutput(ctx, iam.UsersOutputArgs{
UserNames: pulumi.StringArray{
fooUser.UserName,
},
}, nil)
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.iam.User;
import com.pulumi.volcengine.iam.UserArgs;
import com.pulumi.volcengine.iam.IamFunctions;
import com.pulumi.volcengine.iam.inputs.UsersArgs;
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) {
var fooUser = new User("fooUser", UserArgs.builder()
.userName("acc-test-user")
.description("acc test")
.displayName("name")
.build());
final var fooUsers = IamFunctions.Users(UsersArgs.builder()
.userNames(fooUser.userName())
.build());
}
}
import pulumi
import pulumi_volcengine as volcengine
foo_user = volcengine.iam.User("fooUser",
user_name="acc-test-user",
description="acc test",
display_name="name")
foo_users = volcengine.iam.users_output(user_names=[foo_user.user_name])
import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";
import * as volcengine from "@volcengine/pulumi";
const fooUser = new volcengine.iam.User("fooUser", {
userName: "acc-test-user",
description: "acc test",
displayName: "name",
});
const fooUsers = volcengine.iam.UsersOutput({
userNames: [fooUser.userName],
});
resources:
fooUser:
type: volcengine:iam:User
properties:
userName: acc-test-user
description: acc test
displayName: name
variables:
fooUsers:
fn::invoke:
Function: volcengine:iam:Users
Arguments:
userNames:
- ${fooUser.userName}
Using Users
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 users(args: UsersArgs, opts?: InvokeOptions): Promise<UsersResult>
function usersOutput(args: UsersOutputArgs, opts?: InvokeOptions): Output<UsersResult>
def users(name_regex: Optional[str] = None,
output_file: Optional[str] = None,
user_names: Optional[Sequence[str]] = None,
opts: Optional[InvokeOptions] = None) -> UsersResult
def users_output(name_regex: Optional[pulumi.Input[str]] = None,
output_file: Optional[pulumi.Input[str]] = None,
user_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[UsersResult]
func Users(ctx *Context, args *UsersArgs, opts ...InvokeOption) (*UsersResult, error)
func UsersOutput(ctx *Context, args *UsersOutputArgs, opts ...InvokeOption) UsersResultOutput
public static class Users
{
public static Task<UsersResult> InvokeAsync(UsersArgs args, InvokeOptions? opts = null)
public static Output<UsersResult> Invoke(UsersInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<UsersResult> users(UsersArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: volcengine:iam:Users
arguments:
# arguments dictionary
The following arguments are supported:
- Name
Regex string - A Name Regex of IAM.
- Output
File string - File name where to save data source results.
- User
Names List<string> - A list of user names.
- Name
Regex string - A Name Regex of IAM.
- Output
File string - File name where to save data source results.
- User
Names []string - A list of user names.
- name
Regex String - A Name Regex of IAM.
- output
File String - File name where to save data source results.
- user
Names List<String> - A list of user names.
- name
Regex string - A Name Regex of IAM.
- output
File string - File name where to save data source results.
- user
Names string[] - A list of user names.
- name_
regex str - A Name Regex of IAM.
- output_
file str - File name where to save data source results.
- user_
names Sequence[str] - A list of user names.
- name
Regex String - A Name Regex of IAM.
- output
File String - File name where to save data source results.
- user
Names List<String> - A list of user names.
Users Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Total
Count int - The total count of user query.
- Users
List<Users
User> - The collection of user.
- Name
Regex string - Output
File string - User
Names List<string>
- Id string
- The provider-assigned unique ID for this managed resource.
- Total
Count int - The total count of user query.
- Users
[]Users
User - The collection of user.
- Name
Regex string - Output
File string - User
Names []string
- id String
- The provider-assigned unique ID for this managed resource.
- total
Count Integer - The total count of user query.
- users
List<Users
User> - The collection of user.
- name
Regex String - output
File String - user
Names List<String>
- id string
- The provider-assigned unique ID for this managed resource.
- total
Count number - The total count of user query.
- users
Users
User[] - The collection of user.
- name
Regex string - output
File string - user
Names string[]
- id str
- The provider-assigned unique ID for this managed resource.
- total_
count int - The total count of user query.
- users
Sequence[Users
User] - The collection of user.
- name_
regex str - output_
file str - user_
names Sequence[str]
- id String
- The provider-assigned unique ID for this managed resource.
- total
Count Number - The total count of user query.
- users List<Property Map>
- The collection of user.
- name
Regex String - output
File String - user
Names List<String>
Supporting Types
UsersUser
- Account
Id string - Main account ID to which the sub-user belongs.
- Create
Date string - The create date of the user.
- Description string
- The description of the user.
- Display
Name string - The display name of the user.
- Email string
- The email of the user.
- Email
Is boolVerify - Whether the email has been verified.
- Mobile
Phone string - The mobile phone of the user.
- Mobile
Phone boolIs Verify - Whether the phone number has been verified.
- Trn string
- The trn of the user.
- Update
Date string - The update date of the user.
- User
Id string - The id of the user.
- User
Name string - The name of the user.
- Account
Id string - Main account ID to which the sub-user belongs.
- Create
Date string - The create date of the user.
- Description string
- The description of the user.
- Display
Name string - The display name of the user.
- Email string
- The email of the user.
- Email
Is boolVerify - Whether the email has been verified.
- Mobile
Phone string - The mobile phone of the user.
- Mobile
Phone boolIs Verify - Whether the phone number has been verified.
- Trn string
- The trn of the user.
- Update
Date string - The update date of the user.
- User
Id string - The id of the user.
- User
Name string - The name of the user.
- account
Id String - Main account ID to which the sub-user belongs.
- create
Date String - The create date of the user.
- description String
- The description of the user.
- display
Name String - The display name of the user.
- email String
- The email of the user.
- email
Is BooleanVerify - Whether the email has been verified.
- mobile
Phone String - The mobile phone of the user.
- mobile
Phone BooleanIs Verify - Whether the phone number has been verified.
- trn String
- The trn of the user.
- update
Date String - The update date of the user.
- user
Id String - The id of the user.
- user
Name String - The name of the user.
- account
Id string - Main account ID to which the sub-user belongs.
- create
Date string - The create date of the user.
- description string
- The description of the user.
- display
Name string - The display name of the user.
- email string
- The email of the user.
- email
Is booleanVerify - Whether the email has been verified.
- mobile
Phone string - The mobile phone of the user.
- mobile
Phone booleanIs Verify - Whether the phone number has been verified.
- trn string
- The trn of the user.
- update
Date string - The update date of the user.
- user
Id string - The id of the user.
- user
Name string - The name of the user.
- account_
id str - Main account ID to which the sub-user belongs.
- create_
date str - The create date of the user.
- description str
- The description of the user.
- display_
name str - The display name of the user.
- email str
- The email of the user.
- email_
is_ boolverify - Whether the email has been verified.
- mobile_
phone str - The mobile phone of the user.
- mobile_
phone_ boolis_ verify - Whether the phone number has been verified.
- trn str
- The trn of the user.
- update_
date str - The update date of the user.
- user_
id str - The id of the user.
- user_
name str - The name of the user.
- account
Id String - Main account ID to which the sub-user belongs.
- create
Date String - The create date of the user.
- description String
- The description of the user.
- display
Name String - The display name of the user.
- email String
- The email of the user.
- email
Is BooleanVerify - Whether the email has been verified.
- mobile
Phone String - The mobile phone of the user.
- mobile
Phone BooleanIs Verify - Whether the phone number has been verified.
- trn String
- The trn of the user.
- update
Date String - The update date of the user.
- user
Id String - The id of the user.
- user
Name String - The name of the user.
Package Details
- Repository
- volcengine volcengine/pulumi-volcengine
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
volcengine
Terraform Provider.