interface UserPoolIdentityProviderSamlProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Cognito.UserPoolIdentityProviderSamlProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awscognito#UserPoolIdentityProviderSamlProps |
Java | software.amazon.awscdk.services.cognito.UserPoolIdentityProviderSamlProps |
Python | aws_cdk.aws_cognito.UserPoolIdentityProviderSamlProps |
TypeScript (source) | aws-cdk-lib » aws_cognito » UserPoolIdentityProviderSamlProps |
Properties to initialize UserPoolIdentityProviderSaml.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
declare const providerAttribute: cognito.ProviderAttribute;
declare const userPool: cognito.UserPool;
declare const userPoolIdentityProviderSamlMetadata: cognito.UserPoolIdentityProviderSamlMetadata;
const userPoolIdentityProviderSamlProps: cognito.UserPoolIdentityProviderSamlProps = {
metadata: userPoolIdentityProviderSamlMetadata,
userPool: userPool,
// the properties below are optional
attributeMapping: {
address: providerAttribute,
birthdate: providerAttribute,
custom: {
customKey: providerAttribute,
},
email: providerAttribute,
familyName: providerAttribute,
fullname: providerAttribute,
gender: providerAttribute,
givenName: providerAttribute,
lastUpdateTime: providerAttribute,
locale: providerAttribute,
middleName: providerAttribute,
nickname: providerAttribute,
phoneNumber: providerAttribute,
preferredUsername: providerAttribute,
profilePage: providerAttribute,
profilePicture: providerAttribute,
timezone: providerAttribute,
website: providerAttribute,
},
identifiers: ['identifiers'],
idpSignout: false,
name: 'name',
};
Properties
Name | Type | Description |
---|---|---|
metadata | User | The SAML metadata. |
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. |
identifiers? | string[] | Identifiers. |
idp | boolean | Whether to enable the "Sign-out flow" feature. |
name? | string | The name of the provider. |
metadata
Type:
User
The SAML metadata.
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.
identifiers?
Type:
string[]
(optional, default: no identifiers used)
Identifiers.
Identifiers can be used to redirect users to the correct IdP in multitenant apps.
idpSignout?
Type:
boolean
(optional, default: false)
Whether to enable the "Sign-out flow" feature.
name?
Type:
string
(optional, default: the unique ID of the construct)
The name of the provider.
Must be between 3 and 32 characters.