Package software.amazon.awscdk.services.cognito

Interface CfnUserPool.CustomSMSSenderProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPool.CustomSMSSenderProperty.Jsii$Proxy

Enclosing class:

CfnUserPool

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

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 software.amazon.awscdk.services.cognito.*;
 CustomSMSSenderProperty customSMSSenderProperty = CustomSMSSenderProperty.builder()
         .lambdaArn("lambdaArn")
         .lambdaVersion("lambdaVersion")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-customsmssender.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnUserPool.CustomSMSSenderProperty.Builder	builder()
default String	getLambdaArn()	The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.
default String	getLambdaVersion()	The user pool trigger version of the request that Amazon Cognito sends to your 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 function that you want to assign to your Lambda trigger.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-customsmssender.html#cfn-cognito-userpool-customsmssender-lambdaarn

getLambdaVersion

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-customsmssender.html#cfn-cognito-userpool-customsmssender-lambdaversion

builder

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

Returns:

a CfnUserPool.CustomSMSSenderProperty.Builder of CfnUserPool.CustomSMSSenderProperty