class CfnUserPropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.IdentityStore.CfnUserPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsidentitystore#CfnUserPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.identitystore.CfnUserPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_identitystore.CfnUserPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_identitystore » CfnUserPropsMixin

Implements IMixin

Extends Mixin

Creates a user within the specified identity store.

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/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnUserPropsMixin = new identitystore.CfnUserPropsMixin({
  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',
  }],
  identityStoreId: 'identityStoreId',
  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: [{
    display: 'display',
    primary: false,
    type: 'type',
    value: 'value',
  }],
  preferredLanguage: 'preferredLanguage',
  profileUrl: 'profileUrl',
  roles: [{
    primary: false,
    type: 'type',
    value: 'value',
  }],
  timezone: 'timezone',
  title: 'title',
  userName: 'userName',
  userType: 'userType',
  website: 'website',
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnUserPropsMixin(props: CfnUserMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnUserMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::IdentityStore::User.

Properties

Name	Type	Description
props	CfnUserMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnUserMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.