Package software.amazon.awscdk.services.cognito

Interface CfnUserPool.CustomEmailSenderProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPool.CustomEmailSenderProperty.Jsii$Proxy

Enclosing class:

CfnUserPool

@Stability(Stable)
public static interface CfnUserPool.CustomEmailSenderProperty
extends software.amazon.jsii.JsiiSerializable

A custom email sender AWS Lambda trigger.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 CustomEmailSenderProperty customEmailSenderProperty = CustomEmailSenderProperty.builder()
         .lambdaArn("lambdaArn")
         .lambdaVersion("lambdaVersion")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPool.CustomEmailSenderProperty.Builder	A builder for CfnUserPool.CustomEmailSenderProperty
static final class	CfnUserPool.CustomEmailSenderProperty.Jsii$Proxy	An implementation for CfnUserPool.CustomEmailSenderProperty

Method Summary

Modifier and Type	Method	Description
static CfnUserPool.CustomEmailSenderProperty.Builder	builder()
default String	getLambdaArn()	The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Cognito triggers to send email notifications to users.
default String	getLambdaVersion()	The Lambda version represents the signature of the "request" attribute in the "event" information that Amazon Cognito passes to your custom email sender AWS Lambda function.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLambdaArn

@Stability(Stable)
@Nullable
default String getLambdaArn()

The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Cognito triggers to send email notifications to users.

getLambdaVersion

@Stability(Stable)
@Nullable
default String getLambdaVersion()

The Lambda version represents the signature of the "request" attribute in the "event" information that Amazon Cognito passes to your custom email sender AWS Lambda function.

The only supported value is V1_0 .

builder

@Stability(Stable)
static CfnUserPool.CustomEmailSenderProperty.Builder builder()

Returns:

a CfnUserPool.CustomEmailSenderProperty.Builder of CfnUserPool.CustomEmailSenderProperty