Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 1.58 KB

sam-property-function-cognito.md

File metadata and controls

45 lines (32 loc) · 1.58 KB
Raw

Cognito

The object describing a Cognito event source type.

Syntax

To declare this entity in your AWS Serverless Application Model (AWS SAM) template, use the following syntax.

YAML

  [Trigger](#sam-function-cognito-trigger): List
  [UserPool](#sam-function-cognito-userpool): String

Properties

Trigger The Lambda trigger configuration information for the new user pool.
Type: List
Required: Yes
AWS CloudFormation compatibility: This property is passed directly to the [LambdaConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html) property of an AWS::Cognito::UserPool resource.

UserPool Reference to UserPool defined in the same template
Type: String
Required: Yes
AWS CloudFormation compatibility: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent.

Examples

Cognito Event

Cognito Event Example

YAML

CognitoUserPoolPreSignup:
  Type: Cognito
  Properties:
    UserPool:
      Ref: MyCognitoUserPool
    Trigger: PreSignUp