interface CfnUserProps

Language	Type name
.NET	`Amazon.CDK.AWS.IdentityStore.CfnUserProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsidentitystore#CfnUserProps`
Java	`software.amazon.awscdk.services.identitystore.CfnUserProps`
Python	`aws_cdk.aws_identitystore.CfnUserProps`
TypeScript	`aws-cdk-lib` » `aws_identitystore` » `CfnUserProps`

Properties for defining a CfnUser.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-user.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_identitystore as identitystore } from 'aws-cdk-lib';
const cfnUserProps: identitystore.CfnUserProps = {
  identityStoreId: 'identityStoreId',

  // the properties below are optional
  addresses: [{
    country: 'country',
    formatted: 'formatted',
    locality: 'locality',
    postalCode: 'postalCode',
    primary: false,
    region: 'region',
    streetAddress: 'streetAddress',
    type: 'type',
  }],
  birthdate: 'birthdate',
  displayName: 'displayName',
  emails: [{
    primary: false,
    type: 'type',
    value: 'value',
  }],
  locale: 'locale',
  name: {
    familyName: 'familyName',
    formatted: 'formatted',
    givenName: 'givenName',
    honorificPrefix: 'honorificPrefix',
    honorificSuffix: 'honorificSuffix',
    middleName: 'middleName',
  },
  nickName: 'nickName',
  phoneNumbers: [{
    primary: false,
    type: 'type',
    value: 'value',
  }],
  photos: [{
    value: 'value',

    // the properties below are optional
    display: 'display',
    primary: false,
    type: 'type',
  }],
  preferredLanguage: 'preferredLanguage',
  profileUrl: 'profileUrl',
  roles: [{
    primary: false,
    type: 'type',
    value: 'value',
  }],
  timezone: 'timezone',
  title: 'title',
  userName: 'userName',
  userType: 'userType',
  website: 'website',
};

Properties

Name	Type	Description
identityStoreId	`string`	The globally unique identifier for the identity store.
addresses?	`IResolvable` `\| (IResolvable` `\|` `AddressesItemsProperty)[]`	A list of addresses associated with the user.
birthdate?	`string`	The user's birthdate in YYYY-MM-DD format.
displayName?	`string`	A string containing the name of the user for display.
emails?	`IResolvable` `\| (IResolvable` `\|` `EmailsItemsProperty)[]`	A list of email addresses associated with the user.
locale?	`string`	The geographical region or location of the user.
name?	`IResolvable` `\|` `NameProperty`	The name of the user.
nickName?	`string`	An alternate name for the user.
phoneNumbers?	`IResolvable` `\| (IResolvable` `\|` `PhoneNumbersItemsProperty)[]`	A list of phone numbers associated with the user.
photos?	`IResolvable` `\| (IResolvable` `\|` `PhotosItemsProperty)[]`	A list of photos associated with the user.
preferredLanguage?	`string`	The preferred language of the user.
profileUrl?	`string`	A URL associated with the user.
roles?	`IResolvable` `\| (IResolvable` `\|` `RolesItemsProperty)[]`	A list of roles associated with the user.
timezone?	`string`	The time zone for the user.
title?	`string`	The title of the user.
userName?	`string`	A unique string used to identify the user.
userType?	`string`	A string indicating the type of user.
website?	`string`	The user's personal website or blog URL.