Resource: awsIdentitystoreUser
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
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.identitystoreUser.IdentitystoreUser(this, "example", {
displayName: "John Doe",
emails: {
value: "john@example.com",
},
identityStoreId:
"${tolist(data.aws_ssoadmin_instances.example.identity_store_ids)[0]}",
name: {
familyName: "Doe",
givenName: "John",
},
userName: "johndoe",
});
Argument Reference
-> Unless specified otherwise, all fields can contain up to 1024 characters of free-form text.
The following arguments are required:
displayName- (Required) The name that is typically displayed when the user is referenced.identityStoreId- (Required, Forces new resource) The globally unique identifier for the identity store that this user is in.name- (Required) Details about the user's full name. Detailed below.userName- (Required, Forces new resource) 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- (Optional) Details about the user's address. At most 1 address is allowed. Detailed below.emails- (Optional) Details about the user's email. At most 1 email is allowed. Detailed below.locale- (Optional) The user's geographical region or location.nickname- (Optional) An alternate name for the user.phoneNumbers- (Optional) Details about the user's phone number. At most 1 phone number is allowed. Detailed below.preferredLanguage- (Optional) The preferred language of the user.profileUrl- (Optional) An URL that may be associated with the user.timezone- (Optional) The user's time zone.title- (Optional) The user's title.userType- (Optional) The user type.
addresses Configuration Block
country- (Optional) The country that this address is in.formatted- (Optional) The name that is typically displayed when the address is shown for display.locality- (Optional) The address locality.postalCode- (Optional) The postal code of the address.primary- (Optional) Whentrue, this is the primary address associated with the user.region- (Optional) The region of the address.streetAddress- (Optional) The street of the address.type- (Optional) The type of address.
emails Configuration Block
primary- (Optional) Whentrue, this is the primary email associated with the user.type- (Optional) The type of email.value- (Optional) The email address. This value must be unique across the identity store.
name Configuration Block
The following arguments are required:
familyName- (Required) The family name of the user.givenName- (Required) The given name of the user.
The following arguments are optional:
formatted- (Optional) The name that is typically displayed when the name is shown for display.honorificPrefix- (Optional) The honorific prefix of the user.honorificSuffix- (Optional) The honorific suffix of the user.middleName- (Optional) The middle name of the user.
phone_numbers Configuration Block
primary- (Optional) Whentrue, this is the primary phone number associated with the user.type- (Optional) The type of phone number.value- (Optional) The user's phone number.
Attributes Reference
In addition to all arguments above, the following attributes are exported:
externalIds- A list of identifiers issued to this resource by an external identity provider.id- The identifier issued to this resource by an external identity provider.issuer- The issuer for an external identifier.userId- The identifier for this user in the identity store.
Import
An Identity Store User can be imported using the combination identityStoreId/userId. For example: