User Args
This resource manages a User resource within an Identity Store.
Note: If you use an external identity provider or Active Directory as your identity source, use this resource with caution. IAM Identity Center does not support outbound synchronization, so your identity source does not automatically update with the changes that you make to users using this resource.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.identitystore.User("example", {
identityStoreId: exampleAwsSsoadminInstances.identityStoreIds[0],
displayName: "John Doe",
userName: "johndoe",
name: {
givenName: "John",
familyName: "Doe",
},
emails: {
value: "john@example.com",
},
});
import pulumi
import pulumi_aws as aws
example = aws.identitystore.User("example",
identity_store_id=example_aws_ssoadmin_instances["identityStoreIds"],
display_name="John Doe",
user_name="johndoe",
name={
"given_name": "John",
"family_name": "Doe",
},
emails={
"value": "john@example.com",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.IdentityStore.User("example", new()
{
IdentityStoreId = exampleAwsSsoadminInstances.IdentityStoreIds[0],
DisplayName = "John Doe",
UserName = "johndoe",
Name = new Aws.IdentityStore.Inputs.UserNameArgs
{
GivenName = "John",
FamilyName = "Doe",
},
Emails = new Aws.IdentityStore.Inputs.UserEmailsArgs
{
Value = "john@example.com",
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/identitystore"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := identitystore.NewUser(ctx, "example", &identitystore.UserArgs{
IdentityStoreId: pulumi.Any(exampleAwsSsoadminInstances.IdentityStoreIds[0]),
DisplayName: pulumi.String("John Doe"),
UserName: pulumi.String("johndoe"),
Name: &identitystore.UserNameArgs{
GivenName: pulumi.String("John"),
FamilyName: pulumi.String("Doe"),
},
Emails: &identitystore.UserEmailsArgs{
Value: pulumi.String("john@example.com"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.identitystore.User;
import com.pulumi.aws.identitystore.UserArgs;
import com.pulumi.aws.identitystore.inputs.UserNameArgs;
import com.pulumi.aws.identitystore.inputs.UserEmailsArgs;
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 example = new User("example", UserArgs.builder()
.identityStoreId(exampleAwsSsoadminInstances.identityStoreIds()[0])
.displayName("John Doe")
.userName("johndoe")
.name(UserNameArgs.builder()
.givenName("John")
.familyName("Doe")
.build())
.emails(UserEmailsArgs.builder()
.value("john@example.com")
.build())
.build());
}
}
resources:
example:
type: aws:identitystore:User
properties:
identityStoreId: ${exampleAwsSsoadminInstances.identityStoreIds[0]}
displayName: John Doe
userName: johndoe
name:
givenName: John
familyName: Doe
emails:
value: john@example.com
Import
Using pulumi import
, import an Identity Store User using the combination identity_store_id/user_id
. For example:
$ pulumi import aws:identitystore/user:User example d-9c6705e95c/065212b4-9061-703b-5876-13a517ae2a7c
Constructors
Properties
Details about the user's address. At most 1 address is allowed. Detailed below.
The name that is typically displayed when the user is referenced.
Details about the user's email. At most 1 email is allowed. Detailed below.
The globally unique identifier for the identity store that this user is in.
Details about the user's full name. Detailed below.
Details about the user's phone number. At most 1 phone number is allowed. Detailed below.
The preferred language of the user.
An URL that may be associated with the user.
A unique string used to identify the user. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store. The limit is 128 characters. The following arguments are optional: