1. Packages
  2. AWS
  3. API Docs
  4. identitystore
  5. User
AWS v6.77.1 published on Friday, Apr 18, 2025 by Pulumi

aws.identitystore.User

Explore with Pulumi AI

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",
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.identitystore.User("example",
    identity_store_id=example_aws_ssoadmin_instances["identityStoreIds"][0],
    display_name="John Doe",
    user_name="johndoe",
    name={
        "given_name": "John",
        "family_name": "Doe",
    },
    emails={
        "value": "john@example.com",
    })
Copy
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
	})
}
Copy
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",
        },
    });

});
Copy
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());

    }
}
Copy
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
Copy

Create User Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
@overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         identity_store_id: Optional[str] = None,
         display_name: Optional[str] = None,
         user_name: Optional[str] = None,
         nickname: Optional[str] = None,
         locale: Optional[str] = None,
         name: Optional[UserNameArgs] = None,
         addresses: Optional[UserAddressesArgs] = None,
         phone_numbers: Optional[UserPhoneNumbersArgs] = None,
         preferred_language: Optional[str] = None,
         profile_url: Optional[str] = None,
         timezone: Optional[str] = None,
         title: Optional[str] = None,
         emails: Optional[UserEmailsArgs] = None,
         user_type: Optional[str] = None)
func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
public User(string name, UserArgs args, CustomResourceOptions? opts = null)
public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)
type: aws:identitystore:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var exampleuserResourceResourceFromIdentitystoreuser = new Aws.IdentityStore.User("exampleuserResourceResourceFromIdentitystoreuser", new()
{
    IdentityStoreId = "string",
    DisplayName = "string",
    UserName = "string",
    Nickname = "string",
    Locale = "string",
    Name = new Aws.IdentityStore.Inputs.UserNameArgs
    {
        FamilyName = "string",
        GivenName = "string",
        Formatted = "string",
        HonorificPrefix = "string",
        HonorificSuffix = "string",
        MiddleName = "string",
    },
    Addresses = new Aws.IdentityStore.Inputs.UserAddressesArgs
    {
        Country = "string",
        Formatted = "string",
        Locality = "string",
        PostalCode = "string",
        Primary = false,
        Region = "string",
        StreetAddress = "string",
        Type = "string",
    },
    PhoneNumbers = new Aws.IdentityStore.Inputs.UserPhoneNumbersArgs
    {
        Primary = false,
        Type = "string",
        Value = "string",
    },
    PreferredLanguage = "string",
    ProfileUrl = "string",
    Timezone = "string",
    Title = "string",
    Emails = new Aws.IdentityStore.Inputs.UserEmailsArgs
    {
        Primary = false,
        Type = "string",
        Value = "string",
    },
    UserType = "string",
});
Copy
example, err := identitystore.NewUser(ctx, "exampleuserResourceResourceFromIdentitystoreuser", &identitystore.UserArgs{
	IdentityStoreId: pulumi.String("string"),
	DisplayName:     pulumi.String("string"),
	UserName:        pulumi.String("string"),
	Nickname:        pulumi.String("string"),
	Locale:          pulumi.String("string"),
	Name: &identitystore.UserNameArgs{
		FamilyName:      pulumi.String("string"),
		GivenName:       pulumi.String("string"),
		Formatted:       pulumi.String("string"),
		HonorificPrefix: pulumi.String("string"),
		HonorificSuffix: pulumi.String("string"),
		MiddleName:      pulumi.String("string"),
	},
	Addresses: &identitystore.UserAddressesArgs{
		Country:       pulumi.String("string"),
		Formatted:     pulumi.String("string"),
		Locality:      pulumi.String("string"),
		PostalCode:    pulumi.String("string"),
		Primary:       pulumi.Bool(false),
		Region:        pulumi.String("string"),
		StreetAddress: pulumi.String("string"),
		Type:          pulumi.String("string"),
	},
	PhoneNumbers: &identitystore.UserPhoneNumbersArgs{
		Primary: pulumi.Bool(false),
		Type:    pulumi.String("string"),
		Value:   pulumi.String("string"),
	},
	PreferredLanguage: pulumi.String("string"),
	ProfileUrl:        pulumi.String("string"),
	Timezone:          pulumi.String("string"),
	Title:             pulumi.String("string"),
	Emails: &identitystore.UserEmailsArgs{
		Primary: pulumi.Bool(false),
		Type:    pulumi.String("string"),
		Value:   pulumi.String("string"),
	},
	UserType: pulumi.String("string"),
})
Copy
var exampleuserResourceResourceFromIdentitystoreuser = new com.pulumi.aws.identitystore.User("exampleuserResourceResourceFromIdentitystoreuser", com.pulumi.aws.identitystore.UserArgs.builder()
    .identityStoreId("string")
    .displayName("string")
    .userName("string")
    .nickname("string")
    .locale("string")
    .name(UserNameArgs.builder()
        .familyName("string")
        .givenName("string")
        .formatted("string")
        .honorificPrefix("string")
        .honorificSuffix("string")
        .middleName("string")
        .build())
    .addresses(UserAddressesArgs.builder()
        .country("string")
        .formatted("string")
        .locality("string")
        .postalCode("string")
        .primary(false)
        .region("string")
        .streetAddress("string")
        .type("string")
        .build())
    .phoneNumbers(UserPhoneNumbersArgs.builder()
        .primary(false)
        .type("string")
        .value("string")
        .build())
    .preferredLanguage("string")
    .profileUrl("string")
    .timezone("string")
    .title("string")
    .emails(UserEmailsArgs.builder()
        .primary(false)
        .type("string")
        .value("string")
        .build())
    .userType("string")
    .build());
Copy
exampleuser_resource_resource_from_identitystoreuser = aws.identitystore.User("exampleuserResourceResourceFromIdentitystoreuser",
    identity_store_id="string",
    display_name="string",
    user_name="string",
    nickname="string",
    locale="string",
    name={
        "family_name": "string",
        "given_name": "string",
        "formatted": "string",
        "honorific_prefix": "string",
        "honorific_suffix": "string",
        "middle_name": "string",
    },
    addresses={
        "country": "string",
        "formatted": "string",
        "locality": "string",
        "postal_code": "string",
        "primary": False,
        "region": "string",
        "street_address": "string",
        "type": "string",
    },
    phone_numbers={
        "primary": False,
        "type": "string",
        "value": "string",
    },
    preferred_language="string",
    profile_url="string",
    timezone="string",
    title="string",
    emails={
        "primary": False,
        "type": "string",
        "value": "string",
    },
    user_type="string")
Copy
const exampleuserResourceResourceFromIdentitystoreuser = new aws.identitystore.User("exampleuserResourceResourceFromIdentitystoreuser", {
    identityStoreId: "string",
    displayName: "string",
    userName: "string",
    nickname: "string",
    locale: "string",
    name: {
        familyName: "string",
        givenName: "string",
        formatted: "string",
        honorificPrefix: "string",
        honorificSuffix: "string",
        middleName: "string",
    },
    addresses: {
        country: "string",
        formatted: "string",
        locality: "string",
        postalCode: "string",
        primary: false,
        region: "string",
        streetAddress: "string",
        type: "string",
    },
    phoneNumbers: {
        primary: false,
        type: "string",
        value: "string",
    },
    preferredLanguage: "string",
    profileUrl: "string",
    timezone: "string",
    title: "string",
    emails: {
        primary: false,
        type: "string",
        value: "string",
    },
    userType: "string",
});
Copy
type: aws:identitystore:User
properties:
    addresses:
        country: string
        formatted: string
        locality: string
        postalCode: string
        primary: false
        region: string
        streetAddress: string
        type: string
    displayName: string
    emails:
        primary: false
        type: string
        value: string
    identityStoreId: string
    locale: string
    name:
        familyName: string
        formatted: string
        givenName: string
        honorificPrefix: string
        honorificSuffix: string
        middleName: string
    nickname: string
    phoneNumbers:
        primary: false
        type: string
        value: string
    preferredLanguage: string
    profileUrl: string
    timezone: string
    title: string
    userName: string
    userType: string
Copy

User Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The User resource accepts the following input properties:

DisplayName This property is required. string
The name that is typically displayed when the user is referenced.
IdentityStoreId
This property is required.
Changes to this property will trigger replacement.
string
The globally unique identifier for the identity store that this user is in.
UserName
This property is required.
Changes to this property will trigger replacement.
string

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:

Addresses UserAddresses
Details about the user's address. At most 1 address is allowed. Detailed below.
Emails UserEmails
Details about the user's email. At most 1 email is allowed. Detailed below.
Locale string
The user's geographical region or location.
Name UserName
Details about the user's full name. Detailed below.
Nickname string
An alternate name for the user.
PhoneNumbers UserPhoneNumbers
Details about the user's phone number. At most 1 phone number is allowed. Detailed below.
PreferredLanguage string
The preferred language of the user.
ProfileUrl string
An URL that may be associated with the user.
Timezone string
The user's time zone.
Title string
The user's title.
UserType string
The user type.
DisplayName This property is required. string
The name that is typically displayed when the user is referenced.
IdentityStoreId
This property is required.
Changes to this property will trigger replacement.
string
The globally unique identifier for the identity store that this user is in.
UserName
This property is required.
Changes to this property will trigger replacement.
string

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:

Addresses UserAddressesArgs
Details about the user's address. At most 1 address is allowed. Detailed below.
Emails UserEmailsArgs
Details about the user's email. At most 1 email is allowed. Detailed below.
Locale string
The user's geographical region or location.
Name UserNameArgs
Details about the user's full name. Detailed below.
Nickname string
An alternate name for the user.
PhoneNumbers UserPhoneNumbersArgs
Details about the user's phone number. At most 1 phone number is allowed. Detailed below.
PreferredLanguage string
The preferred language of the user.
ProfileUrl string
An URL that may be associated with the user.
Timezone string
The user's time zone.
Title string
The user's title.
UserType string
The user type.
displayName This property is required. String
The name that is typically displayed when the user is referenced.
identityStoreId
This property is required.
Changes to this property will trigger replacement.
String
The globally unique identifier for the identity store that this user is in.
userName
This property is required.
Changes to this property will trigger replacement.
String

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:

addresses UserAddresses
Details about the user's address. At most 1 address is allowed. Detailed below.
emails UserEmails
Details about the user's email. At most 1 email is allowed. Detailed below.
locale String
The user's geographical region or location.
name UserName
Details about the user's full name. Detailed below.
nickname String
An alternate name for the user.
phoneNumbers UserPhoneNumbers
Details about the user's phone number. At most 1 phone number is allowed. Detailed below.
preferredLanguage String
The preferred language of the user.
profileUrl String
An URL that may be associated with the user.
timezone String
The user's time zone.
title String
The user's title.
userType String
The user type.
displayName This property is required. string
The name that is typically displayed when the user is referenced.
identityStoreId
This property is required.
Changes to this property will trigger replacement.
string
The globally unique identifier for the identity store that this user is in.
userName
This property is required.
Changes to this property will trigger replacement.
string

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:

addresses UserAddresses
Details about the user's address. At most 1 address is allowed. Detailed below.
emails UserEmails
Details about the user's email. At most 1 email is allowed. Detailed below.
locale string
The user's geographical region or location.
name UserName
Details about the user's full name. Detailed below.
nickname string
An alternate name for the user.
phoneNumbers UserPhoneNumbers
Details about the user's phone number. At most 1 phone number is allowed. Detailed below.
preferredLanguage string
The preferred language of the user.
profileUrl string
An URL that may be associated with the user.
timezone string
The user's time zone.
title string
The user's title.
userType string
The user type.
display_name This property is required. str
The name that is typically displayed when the user is referenced.
identity_store_id
This property is required.
Changes to this property will trigger replacement.
str
The globally unique identifier for the identity store that this user is in.
user_name
This property is required.
Changes to this property will trigger replacement.
str

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:

addresses UserAddressesArgs
Details about the user's address. At most 1 address is allowed. Detailed below.
emails UserEmailsArgs
Details about the user's email. At most 1 email is allowed. Detailed below.
locale str
The user's geographical region or location.
name UserNameArgs
Details about the user's full name. Detailed below.
nickname str
An alternate name for the user.
phone_numbers UserPhoneNumbersArgs
Details about the user's phone number. At most 1 phone number is allowed. Detailed below.
preferred_language str
The preferred language of the user.
profile_url str
An URL that may be associated with the user.
timezone str
The user's time zone.
title str
The user's title.
user_type str
The user type.
displayName This property is required. String
The name that is typically displayed when the user is referenced.
identityStoreId
This property is required.
Changes to this property will trigger replacement.
String
The globally unique identifier for the identity store that this user is in.
userName
This property is required.
Changes to this property will trigger replacement.
String

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:

addresses Property Map
Details about the user's address. At most 1 address is allowed. Detailed below.
emails Property Map
Details about the user's email. At most 1 email is allowed. Detailed below.
locale String
The user's geographical region or location.
name Property Map
Details about the user's full name. Detailed below.
nickname String
An alternate name for the user.
phoneNumbers Property Map
Details about the user's phone number. At most 1 phone number is allowed. Detailed below.
preferredLanguage String
The preferred language of the user.
profileUrl String
An URL that may be associated with the user.
timezone String
The user's time zone.
title String
The user's title.
userType String
The user type.

Outputs

All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

ExternalIds List<UserExternalId>
A list of identifiers issued to this resource by an external identity provider.
Id string
The provider-assigned unique ID for this managed resource.
UserId string
The identifier for this user in the identity store.
ExternalIds []UserExternalId
A list of identifiers issued to this resource by an external identity provider.
Id string
The provider-assigned unique ID for this managed resource.
UserId string
The identifier for this user in the identity store.
externalIds List<UserExternalId>
A list of identifiers issued to this resource by an external identity provider.
id String
The provider-assigned unique ID for this managed resource.
userId String
The identifier for this user in the identity store.
externalIds UserExternalId[]
A list of identifiers issued to this resource by an external identity provider.
id string
The provider-assigned unique ID for this managed resource.
userId string
The identifier for this user in the identity store.
external_ids Sequence[UserExternalId]
A list of identifiers issued to this resource by an external identity provider.
id str
The provider-assigned unique ID for this managed resource.
user_id str
The identifier for this user in the identity store.
externalIds List<Property Map>
A list of identifiers issued to this resource by an external identity provider.
id String
The provider-assigned unique ID for this managed resource.
userId String
The identifier for this user in the identity store.

Look up Existing User Resource

Get an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: UserState, opts?: CustomResourceOptions): User
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        addresses: Optional[UserAddressesArgs] = None,
        display_name: Optional[str] = None,
        emails: Optional[UserEmailsArgs] = None,
        external_ids: Optional[Sequence[UserExternalIdArgs]] = None,
        identity_store_id: Optional[str] = None,
        locale: Optional[str] = None,
        name: Optional[UserNameArgs] = None,
        nickname: Optional[str] = None,
        phone_numbers: Optional[UserPhoneNumbersArgs] = None,
        preferred_language: Optional[str] = None,
        profile_url: Optional[str] = None,
        timezone: Optional[str] = None,
        title: Optional[str] = None,
        user_id: Optional[str] = None,
        user_name: Optional[str] = None,
        user_type: Optional[str] = None) -> User
func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
resources:  _:    type: aws:identitystore:User    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Addresses UserAddresses
Details about the user's address. At most 1 address is allowed. Detailed below.
DisplayName string
The name that is typically displayed when the user is referenced.
Emails UserEmails
Details about the user's email. At most 1 email is allowed. Detailed below.
ExternalIds List<UserExternalId>
A list of identifiers issued to this resource by an external identity provider.
IdentityStoreId Changes to this property will trigger replacement. string
The globally unique identifier for the identity store that this user is in.
Locale string
The user's geographical region or location.
Name UserName
Details about the user's full name. Detailed below.
Nickname string
An alternate name for the user.
PhoneNumbers UserPhoneNumbers
Details about the user's phone number. At most 1 phone number is allowed. Detailed below.
PreferredLanguage string
The preferred language of the user.
ProfileUrl string
An URL that may be associated with the user.
Timezone string
The user's time zone.
Title string
The user's title.
UserId string
The identifier for this user in the identity store.
UserName Changes to this property will trigger replacement. string

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:

UserType string
The user type.
Addresses UserAddressesArgs
Details about the user's address. At most 1 address is allowed. Detailed below.
DisplayName string
The name that is typically displayed when the user is referenced.
Emails UserEmailsArgs
Details about the user's email. At most 1 email is allowed. Detailed below.
ExternalIds []UserExternalIdArgs
A list of identifiers issued to this resource by an external identity provider.
IdentityStoreId Changes to this property will trigger replacement. string
The globally unique identifier for the identity store that this user is in.
Locale string
The user's geographical region or location.
Name UserNameArgs
Details about the user's full name. Detailed below.
Nickname string
An alternate name for the user.
PhoneNumbers UserPhoneNumbersArgs
Details about the user's phone number. At most 1 phone number is allowed. Detailed below.
PreferredLanguage string
The preferred language of the user.
ProfileUrl string
An URL that may be associated with the user.
Timezone string
The user's time zone.
Title string
The user's title.
UserId string
The identifier for this user in the identity store.
UserName Changes to this property will trigger replacement. string

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:

UserType string
The user type.
addresses UserAddresses
Details about the user's address. At most 1 address is allowed. Detailed below.
displayName String
The name that is typically displayed when the user is referenced.
emails UserEmails
Details about the user's email. At most 1 email is allowed. Detailed below.
externalIds List<UserExternalId>
A list of identifiers issued to this resource by an external identity provider.
identityStoreId Changes to this property will trigger replacement. String
The globally unique identifier for the identity store that this user is in.
locale String
The user's geographical region or location.
name UserName
Details about the user's full name. Detailed below.
nickname String
An alternate name for the user.
phoneNumbers UserPhoneNumbers
Details about the user's phone number. At most 1 phone number is allowed. Detailed below.
preferredLanguage String
The preferred language of the user.
profileUrl String
An URL that may be associated with the user.
timezone String
The user's time zone.
title String
The user's title.
userId String
The identifier for this user in the identity store.
userName Changes to this property will trigger replacement. String

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:

userType String
The user type.
addresses UserAddresses
Details about the user's address. At most 1 address is allowed. Detailed below.
displayName string
The name that is typically displayed when the user is referenced.
emails UserEmails
Details about the user's email. At most 1 email is allowed. Detailed below.
externalIds UserExternalId[]
A list of identifiers issued to this resource by an external identity provider.
identityStoreId Changes to this property will trigger replacement. string
The globally unique identifier for the identity store that this user is in.
locale string
The user's geographical region or location.
name UserName
Details about the user's full name. Detailed below.
nickname string
An alternate name for the user.
phoneNumbers UserPhoneNumbers
Details about the user's phone number. At most 1 phone number is allowed. Detailed below.
preferredLanguage string
The preferred language of the user.
profileUrl string
An URL that may be associated with the user.
timezone string
The user's time zone.
title string
The user's title.
userId string
The identifier for this user in the identity store.
userName Changes to this property will trigger replacement. string

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:

userType string
The user type.
addresses UserAddressesArgs
Details about the user's address. At most 1 address is allowed. Detailed below.
display_name str
The name that is typically displayed when the user is referenced.
emails UserEmailsArgs
Details about the user's email. At most 1 email is allowed. Detailed below.
external_ids Sequence[UserExternalIdArgs]
A list of identifiers issued to this resource by an external identity provider.
identity_store_id Changes to this property will trigger replacement. str
The globally unique identifier for the identity store that this user is in.
locale str
The user's geographical region or location.
name UserNameArgs
Details about the user's full name. Detailed below.
nickname str
An alternate name for the user.
phone_numbers UserPhoneNumbersArgs
Details about the user's phone number. At most 1 phone number is allowed. Detailed below.
preferred_language str
The preferred language of the user.
profile_url str
An URL that may be associated with the user.
timezone str
The user's time zone.
title str
The user's title.
user_id str
The identifier for this user in the identity store.
user_name Changes to this property will trigger replacement. str

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:

user_type str
The user type.
addresses Property Map
Details about the user's address. At most 1 address is allowed. Detailed below.
displayName String
The name that is typically displayed when the user is referenced.
emails Property Map
Details about the user's email. At most 1 email is allowed. Detailed below.
externalIds List<Property Map>
A list of identifiers issued to this resource by an external identity provider.
identityStoreId Changes to this property will trigger replacement. String
The globally unique identifier for the identity store that this user is in.
locale String
The user's geographical region or location.
name Property Map
Details about the user's full name. Detailed below.
nickname String
An alternate name for the user.
phoneNumbers Property Map
Details about the user's phone number. At most 1 phone number is allowed. Detailed below.
preferredLanguage String
The preferred language of the user.
profileUrl String
An URL that may be associated with the user.
timezone String
The user's time zone.
title String
The user's title.
userId String
The identifier for this user in the identity store.
userName Changes to this property will trigger replacement. String

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:

userType String
The user type.

Supporting Types

UserAddresses
, UserAddressesArgs

Country string
The country that this address is in.
Formatted string
The name that is typically displayed when the address is shown for display.
Locality string
The address locality.
PostalCode string
The postal code of the address.
Primary bool
When true, this is the primary address associated with the user.
Region string
The region of the address.
StreetAddress string
The street of the address.
Type string
The type of address.
Country string
The country that this address is in.
Formatted string
The name that is typically displayed when the address is shown for display.
Locality string
The address locality.
PostalCode string
The postal code of the address.
Primary bool
When true, this is the primary address associated with the user.
Region string
The region of the address.
StreetAddress string
The street of the address.
Type string
The type of address.
country String
The country that this address is in.
formatted String
The name that is typically displayed when the address is shown for display.
locality String
The address locality.
postalCode String
The postal code of the address.
primary Boolean
When true, this is the primary address associated with the user.
region String
The region of the address.
streetAddress String
The street of the address.
type String
The type of address.
country string
The country that this address is in.
formatted string
The name that is typically displayed when the address is shown for display.
locality string
The address locality.
postalCode string
The postal code of the address.
primary boolean
When true, this is the primary address associated with the user.
region string
The region of the address.
streetAddress string
The street of the address.
type string
The type of address.
country str
The country that this address is in.
formatted str
The name that is typically displayed when the address is shown for display.
locality str
The address locality.
postal_code str
The postal code of the address.
primary bool
When true, this is the primary address associated with the user.
region str
The region of the address.
street_address str
The street of the address.
type str
The type of address.
country String
The country that this address is in.
formatted String
The name that is typically displayed when the address is shown for display.
locality String
The address locality.
postalCode String
The postal code of the address.
primary Boolean
When true, this is the primary address associated with the user.
region String
The region of the address.
streetAddress String
The street of the address.
type String
The type of address.

UserEmails
, UserEmailsArgs

Primary bool
When true, this is the primary email associated with the user.
Type string
The type of email.
Value string
The email address. This value must be unique across the identity store.
Primary bool
When true, this is the primary email associated with the user.
Type string
The type of email.
Value string
The email address. This value must be unique across the identity store.
primary Boolean
When true, this is the primary email associated with the user.
type String
The type of email.
value String
The email address. This value must be unique across the identity store.
primary boolean
When true, this is the primary email associated with the user.
type string
The type of email.
value string
The email address. This value must be unique across the identity store.
primary bool
When true, this is the primary email associated with the user.
type str
The type of email.
value str
The email address. This value must be unique across the identity store.
primary Boolean
When true, this is the primary email associated with the user.
type String
The type of email.
value String
The email address. This value must be unique across the identity store.

UserExternalId
, UserExternalIdArgs

Id string
The identifier issued to this resource by an external identity provider.
Issuer string
The issuer for an external identifier.
Id string
The identifier issued to this resource by an external identity provider.
Issuer string
The issuer for an external identifier.
id String
The identifier issued to this resource by an external identity provider.
issuer String
The issuer for an external identifier.
id string
The identifier issued to this resource by an external identity provider.
issuer string
The issuer for an external identifier.
id str
The identifier issued to this resource by an external identity provider.
issuer str
The issuer for an external identifier.
id String
The identifier issued to this resource by an external identity provider.
issuer String
The issuer for an external identifier.

UserName
, UserNameArgs

FamilyName This property is required. string
The family name of the user.
GivenName This property is required. string

The given name of the user.

The following arguments are optional:

Formatted string
The name that is typically displayed when the name is shown for display.
HonorificPrefix string
The honorific prefix of the user.
HonorificSuffix string
The honorific suffix of the user.
MiddleName string
The middle name of the user.
FamilyName This property is required. string
The family name of the user.
GivenName This property is required. string

The given name of the user.

The following arguments are optional:

Formatted string
The name that is typically displayed when the name is shown for display.
HonorificPrefix string
The honorific prefix of the user.
HonorificSuffix string
The honorific suffix of the user.
MiddleName string
The middle name of the user.
familyName This property is required. String
The family name of the user.
givenName This property is required. String

The given name of the user.

The following arguments are optional:

formatted String
The name that is typically displayed when the name is shown for display.
honorificPrefix String
The honorific prefix of the user.
honorificSuffix String
The honorific suffix of the user.
middleName String
The middle name of the user.
familyName This property is required. string
The family name of the user.
givenName This property is required. string

The given name of the user.

The following arguments are optional:

formatted string
The name that is typically displayed when the name is shown for display.
honorificPrefix string
The honorific prefix of the user.
honorificSuffix string
The honorific suffix of the user.
middleName string
The middle name of the user.
family_name This property is required. str
The family name of the user.
given_name This property is required. str

The given name of the user.

The following arguments are optional:

formatted str
The name that is typically displayed when the name is shown for display.
honorific_prefix str
The honorific prefix of the user.
honorific_suffix str
The honorific suffix of the user.
middle_name str
The middle name of the user.
familyName This property is required. String
The family name of the user.
givenName This property is required. String

The given name of the user.

The following arguments are optional:

formatted String
The name that is typically displayed when the name is shown for display.
honorificPrefix String
The honorific prefix of the user.
honorificSuffix String
The honorific suffix of the user.
middleName String
The middle name of the user.

UserPhoneNumbers
, UserPhoneNumbersArgs

Primary bool
When true, this is the primary phone number associated with the user.
Type string
The type of phone number.
Value string
The user's phone number.
Primary bool
When true, this is the primary phone number associated with the user.
Type string
The type of phone number.
Value string
The user's phone number.
primary Boolean
When true, this is the primary phone number associated with the user.
type String
The type of phone number.
value String
The user's phone number.
primary boolean
When true, this is the primary phone number associated with the user.
type string
The type of phone number.
value string
The user's phone number.
primary bool
When true, this is the primary phone number associated with the user.
type str
The type of phone number.
value str
The user's phone number.
primary Boolean
When true, this is the primary phone number associated with the user.
type String
The type of phone number.
value String
The user's phone number.

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
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.