Class: AWSCDK::Cognito::CfnUserPool::CustomSMSSenderProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Cognito::CfnUserPool::CustomSMSSenderProperty

Defined in:

cognito/cfn_user_pool.rb

Overview

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.

See Also:

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

Instance Attribute Summary

• #lambda_arn ⇒ String^? readonly

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

• #lambda_version ⇒ String^? readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(lambda_arn: nil, lambda_version: nil) ⇒ CustomSMSSenderProperty constructor

  A new instance of CustomSMSSenderProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(lambda_arn: nil, lambda_version: nil) ⇒ CustomSMSSenderProperty

Returns a new instance of CustomSMSSenderProperty.

Parameters:

• lambda_arn (String, nil) (defaults to: nil) —

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

• lambda_version (String, nil) (defaults to: nil) —

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

# File 'cognito/cfn_user_pool.rb', line 1139

def initialize(lambda_arn: nil, lambda_version: nil)
  @lambda_arn = lambda_arn
  Jsii::Type.check_type(@lambda_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "lambdaArn") unless @lambda_arn.nil?
  @lambda_version = lambda_version
  Jsii::Type.check_type(@lambda_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "lambdaVersion") unless @lambda_version.nil?
end

Instance Attribute Details

#lambda_arn ⇒ String^? (readonly)

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

Returns:

• (String, nil)

See Also:

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

# File 'cognito/cfn_user_pool.rb', line 1150

def lambda_arn
  @lambda_arn
end

#lambda_version ⇒ String^? (readonly)

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.

Returns:

• (String, nil)

See Also:

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

# File 'cognito/cfn_user_pool.rb', line 1159

def lambda_version
  @lambda_version
end

Class Method Details

.jsii_properties ⇒ Object

# File 'cognito/cfn_user_pool.rb', line 1161

def self.jsii_properties
  {
    :lambda_arn => "lambdaArn",
    :lambda_version => "lambdaVersion",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'cognito/cfn_user_pool.rb', line 1168

def to_jsii
  result = {}
  result.merge!({
    "lambdaArn" => @lambda_arn,
    "lambdaVersion" => @lambda_version,
  })
  result.compact
end