interface CustomSMSSenderProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Cognito.CfnUserPool.CustomSMSSenderProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPool_CustomSMSSenderProperty`
Java	`software.amazon.awscdk.services.cognito.CfnUserPool.CustomSMSSenderProperty`
Python	`aws_cdk.aws_cognito.CfnUserPool.CustomSMSSenderProperty`
TypeScript	`aws-cdk-lib` » `aws_cognito` » `CfnUserPool` » `CustomSMSSenderProperty`

The configuration of a custom SMS sender Lambda trigger.

This trigger routes all SMS notifications from a user pool to a Lambda function that delivers the message using custom logic.

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';
const customSMSSenderProperty: cognito.CfnUserPool.CustomSMSSenderProperty = {
  lambdaArn: 'lambdaArn',
  lambdaVersion: 'lambdaVersion',
};

Properties

Name	Type	Description
lambdaArn?	`string`	The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.
lambdaVersion?	`string`	The user pool trigger version of the request that Amazon Cognito sends to your Lambda function.

lambdaArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

lambdaVersion?

Type: string (optional)

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function.

Higher-numbered versions add fields that support new features.

You must use a LambdaVersion of V1_0 with a custom sender function.