UserPoolIdentityProviderSamlProps

class aws_cdk.aws_cognito.UserPoolIdentityProviderSamlProps(*, user_pool, attribute_mapping=None, metadata, identifiers=None, idp_signout=None, name=None)

Bases: UserPoolIdentityProviderProps

Properties to initialize UserPoolIdentityProviderSaml.

Parameters
  • user_pool (IUserPool) – The user pool to which this construct provides identities.

  • attribute_mapping (Union[AttributeMapping, Dict[str, Any], None]) – Mapping attributes from the identity provider to standard and custom attributes of the user pool. Default: - no attribute mapping

  • metadata (UserPoolIdentityProviderSamlMetadata) – The SAML metadata.

  • identifiers (Optional[Sequence[str]]) – Identifiers. Identifiers can be used to redirect users to the correct IdP in multitenant apps. Default: - no identifiers used

  • idp_signout (Optional[bool]) – Whether to enable the “Sign-out flow” feature. Default: - false

  • name (Optional[str]) – The name of the provider. Must be between 3 and 32 characters. Default: - the unique ID of the construct

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cognito as cognito

# provider_attribute: cognito.ProviderAttribute
# user_pool: cognito.UserPool
# user_pool_identity_provider_saml_metadata: cognito.UserPoolIdentityProviderSamlMetadata

user_pool_identity_provider_saml_props = cognito.UserPoolIdentityProviderSamlProps(
    metadata=user_pool_identity_provider_saml_metadata,
    user_pool=user_pool,

    # the properties below are optional
    attribute_mapping=cognito.AttributeMapping(
        address=provider_attribute,
        birthdate=provider_attribute,
        custom={
            "custom_key": provider_attribute
        },
        email=provider_attribute,
        family_name=provider_attribute,
        fullname=provider_attribute,
        gender=provider_attribute,
        given_name=provider_attribute,
        last_update_time=provider_attribute,
        locale=provider_attribute,
        middle_name=provider_attribute,
        nickname=provider_attribute,
        phone_number=provider_attribute,
        preferred_username=provider_attribute,
        profile_page=provider_attribute,
        profile_picture=provider_attribute,
        timezone=provider_attribute,
        website=provider_attribute
    ),
    identifiers=["identifiers"],
    idp_signout=False,
    name="name"
)

Attributes

attribute_mapping

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

Default
  • no attribute mapping

Return type

Optional[AttributeMapping]

identifiers

Identifiers.

Identifiers can be used to redirect users to the correct IdP in multitenant apps.

Default
  • no identifiers used

Return type

Optional[List[str]]

idp_signout

Whether to enable the “Sign-out flow” feature.

Default
  • false

Return type

Optional[bool]

metadata

The SAML metadata.

Return type

UserPoolIdentityProviderSamlMetadata

name

The name of the provider.

Must be between 3 and 32 characters.

Default
  • the unique ID of the construct

Return type

Optional[str]

user_pool

The user pool to which this construct provides identities.

Return type

IUserPool