aws-cdk-lib.aws_cognito.UserPoolIdentityProviderAmazonProps

interface UserPoolIdentityProviderAmazonProps

LanguageType name
.NETAmazon.CDK.AWS.Cognito.UserPoolIdentityProviderAmazonProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#UserPoolIdentityProviderAmazonProps
Javasoftware.amazon.awscdk.services.cognito.UserPoolIdentityProviderAmazonProps
Pythonaws_cdk.aws_cognito.UserPoolIdentityProviderAmazonProps
TypeScript (source)aws-cdk-lib » aws_cognito » UserPoolIdentityProviderAmazonProps

Properties to initialize UserPoolAmazonIdentityProvider.

Example

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

NameTypeDescription
clientIdstringThe client id recognized by 'Login with Amazon' APIs.
clientSecretstringThe client secret to be accompanied with clientId for 'Login with Amazon' APIs to authenticate the client.
userPoolIUserPoolThe user pool to which this construct provides identities.
attributeMapping?AttributeMappingMapping attributes from the identity provider to standard and custom attributes of the user pool.
scopes?string[]The types of user profile data to obtain for the Amazon profile.

clientId

Type: string

The client id recognized by 'Login with Amazon' APIs.

See also: https://developer.amazon.com/docs/login-with-amazon/security-profile.html#client-identifier


clientSecret

Type: string

The client secret to be accompanied with clientId for 'Login with Amazon' APIs to authenticate the client.

See also: https://developer.amazon.com/docs/login-with-amazon/security-profile.html#client-identifier


userPool

Type: IUserPool

The user pool to which this construct provides identities.


attributeMapping?

Type: AttributeMapping (optional, default: no attribute mapping)

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


scopes?

Type: string[] (optional, default: [ profile ])

The types of user profile data to obtain for the Amazon profile.

See also: https://developer.amazon.com/docs/login-with-amazon/customer-profile.html