AWS CDK Reference

Appearance

v2.274.0

UserPoolIdentityProviderAmazonProps Struct ​

Properties to initialize UserPoolAmazonIdentityProvider.

Source
aws-cognito/lib/user-pool-idps/amazon.ts

Example ​

ts
const pool = new cognito.UserPool(this, 'Pool');
const provider = new cognito.UserPoolIdentityProviderAmazon(this, 'Amazon', {
  userPool: pool,
  clientId: 'amzn-client-id',
  clientSecret: 'amzn-client-secret',
});

const client = pool.addClient('app-client', {
  // ...
  supportedIdentityProviders: [
    cognito.UserPoolClientIdentityProvider.AMAZON,
  ],
});

client.node.addDependency(provider);

Properties ​

attributeMappingoptionalAttributeMappingattribute_mappingoptionalAttributeMappingattributeMappingoptionalAttributeMappingAttributeMappingoptionalAttributeMappingAttributeMappingoptionalAttributeMapping#
Mapping attributes from the identity provider to standard and custom attributes of the user pool.

Default: no attribute mapping

clientIdstringclient_idstrclientIdStringClientIdstringClientId*stringrequired#
The client id recognized by Login with Amazon APIs.
clientSecretstringclient_secretstrclientSecretStringClientSecretstringClientSecret*stringrequired#
The client secret to be accompanied with clientId for Login with Amazon APIs to authenticate the client.
scopesoptionalstring[]scopesoptionaltyping.List[str]scopesoptionalList<String>Scopesoptionalstring[]Scopesoptional*[]*string#
The types of user profile data to obtain for the Amazon profile.

Default: [ profile ]

userPoolIUserPooluser_poolIUserPooluserPoolIUserPoolUserPoolIUserPoolUserPoolIUserPoolrequired#
The user pool to which this construct provides identities.