interface UserPoolIdentityProviderAmazonProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Cognito.UserPoolIdentityProviderAmazonProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awscognito#UserPoolIdentityProviderAmazonProps |
Java | software.amazon.awscdk.services.cognito.UserPoolIdentityProviderAmazonProps |
Python | aws_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
Name | Type | Description |
---|---|---|
client | string | The client id recognized by Login with Amazon APIs. |
client | string | The client secret to be accompanied with clientId for Login with Amazon APIs to authenticate the client. |
user | IUser | The user pool to which this construct provides identities. |
attribute | Attribute | Mapping 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:
IUser
The user pool to which this construct provides identities.
attributeMapping?
Type:
Attribute
(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