userpool-federation

userpool-federation

Adds the ability to attach UserPool Federation through CloudFormation.

Resource

The name for this custom resource is Custom::CognitoUserPoolFederation and supports all the parameters that you can make through the GUI and cli.

Structure

This is the YAML structure you use when using this Custom Resource.

Type: "Custom::CognitoUserPoolFederation"
Properties:
  Properties

See below for the supported Properties.

Properties

These are the supported properties for the resource.

For more details about the properties check the aws cli docs https://docs.aws.amazon.com/cli/latest/reference/cognito-idp/create-identity-provider.html.

Example

AWSTemplateFormatVersion: "2010-09-09"
Description: "Cognito UserPool"

Parameters:
  Environment:
    Description: "What environment"
    Type: "String"
    Default: "dev"

Resources:
  UserPool:
    Type: "AWS::Cognito::UserPool"
    Properties:
      AliasAttributes:
        - "email"
      MfaConfiguration: "OFF"
      UserPoolName: "userpool"

  UserPoolFederationADFS:
    Type: "Custom::CognitoUserPoolFederation"
    DependsOn:
      - "UserPool"
    Properties:
      ProviderName: "ADFS"
      ProviderType: "SAML"
      ProviderDetails:
        MetadataURL: "https://my.domain.com/FederationMetadata.xml"
      ServiceToken: !Sub "arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:cognito-userpool-federation-${AWS::Region}-${Environment}"
      UserPoolId: !Ref "UserPool"