Class: AWSCDK::Cognito::UserPoolTriggers

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cognito/user_pool_triggers.rb

Overview

Triggers for a user pool.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(create_auth_challenge: nil, custom_email_sender: nil, custom_message: nil, custom_sms_sender: nil, define_auth_challenge: nil, post_authentication: nil, post_confirmation: nil, pre_authentication: nil, pre_sign_up: nil, pre_token_generation: nil, user_migration: nil, verify_auth_challenge_response: nil) ⇒ UserPoolTriggers

Returns a new instance of UserPoolTriggers.

Parameters:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'cognito/user_pool_triggers.rb', line 21

def initialize(create_auth_challenge: nil, custom_email_sender: nil, custom_message: nil, custom_sms_sender: nil, define_auth_challenge: nil, post_authentication: nil, post_confirmation: nil, pre_authentication: nil, pre_sign_up: nil, pre_token_generation: nil, user_migration: nil, verify_auth_challenge_response: nil)
  @create_auth_challenge = create_auth_challenge
  Jsii::Type.check_type(@create_auth_challenge, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLklGdW5jdGlvbiJ9")), "createAuthChallenge") unless @create_auth_challenge.nil?
  @custom_email_sender = custom_email_sender
  Jsii::Type.check_type(@custom_email_sender, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLklGdW5jdGlvbiJ9")), "customEmailSender") unless @custom_email_sender.nil?
  @custom_message = custom_message
  Jsii::Type.check_type(@custom_message, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLklGdW5jdGlvbiJ9")), "customMessage") unless @custom_message.nil?
  @custom_sms_sender = custom_sms_sender
  Jsii::Type.check_type(@custom_sms_sender, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLklGdW5jdGlvbiJ9")), "customSmsSender") unless @custom_sms_sender.nil?
  @define_auth_challenge = define_auth_challenge
  Jsii::Type.check_type(@define_auth_challenge, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLklGdW5jdGlvbiJ9")), "defineAuthChallenge") unless @define_auth_challenge.nil?
  @post_authentication = post_authentication
  Jsii::Type.check_type(@post_authentication, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLklGdW5jdGlvbiJ9")), "postAuthentication") unless @post_authentication.nil?
  @post_confirmation = post_confirmation
  Jsii::Type.check_type(@post_confirmation, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLklGdW5jdGlvbiJ9")), "postConfirmation") unless @post_confirmation.nil?
  @pre_authentication = pre_authentication
  Jsii::Type.check_type(@pre_authentication, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLklGdW5jdGlvbiJ9")), "preAuthentication") unless @pre_authentication.nil?
  @pre_sign_up = 
  Jsii::Type.check_type(@pre_sign_up, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLklGdW5jdGlvbiJ9")), "preSignUp") unless @pre_sign_up.nil?
  @pre_token_generation = pre_token_generation
  Jsii::Type.check_type(@pre_token_generation, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLklGdW5jdGlvbiJ9")), "preTokenGeneration") unless @pre_token_generation.nil?
  @user_migration = user_migration
  Jsii::Type.check_type(@user_migration, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLklGdW5jdGlvbiJ9")), "userMigration") unless @user_migration.nil?
  @verify_auth_challenge_response = verify_auth_challenge_response
  Jsii::Type.check_type(@verify_auth_challenge_response, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLklGdW5jdGlvbiJ9")), "verifyAuthChallengeResponse") unless @verify_auth_challenge_response.nil?
end

Instance Attribute Details

#create_auth_challenge ⇒ AWSCDK::Lambda::IFunction? (readonly)

Note:

Default: - no trigger configured

Creates an authentication challenge.

Returns:

See Also:



53
54
55
 
# File 'cognito/user_pool_triggers.rb', line 53

def create_auth_challenge
  @create_auth_challenge
end

#custom_email_sender ⇒ AWSCDK::Lambda::IFunction? (readonly)

Note:

Default: - no trigger configured

Amazon Cognito invokes this trigger to send email notifications to users.

Returns:

See Also:



59
60
61
 
# File 'cognito/user_pool_triggers.rb', line 59

def custom_email_sender
  @custom_email_sender
end

#custom_message ⇒ AWSCDK::Lambda::IFunction? (readonly)

Note:

Default: - no trigger configured

A custom Message AWS Lambda trigger.

Returns:

See Also:



65
66
67
 
# File 'cognito/user_pool_triggers.rb', line 65

def custom_message
  @custom_message
end

#custom_sms_sender ⇒ AWSCDK::Lambda::IFunction? (readonly)

Note:

Default: - no trigger configured

Amazon Cognito invokes this trigger to send SMS notifications to users.

Returns:

See Also:



71
72
73
 
# File 'cognito/user_pool_triggers.rb', line 71

def custom_sms_sender
  @custom_sms_sender
end

#define_auth_challenge ⇒ AWSCDK::Lambda::IFunction? (readonly)

Note:

Default: - no trigger configured

Defines the authentication challenge.

Returns:

See Also:



77
78
79
 
# File 'cognito/user_pool_triggers.rb', line 77

def define_auth_challenge
  @define_auth_challenge
end

#post_authentication ⇒ AWSCDK::Lambda::IFunction? (readonly)

Note:

Default: - no trigger configured

A post-authentication AWS Lambda trigger.

Returns:

See Also:



83
84
85
 
# File 'cognito/user_pool_triggers.rb', line 83

def post_authentication
  @post_authentication
end

#post_confirmation ⇒ AWSCDK::Lambda::IFunction? (readonly)

Note:

Default: - no trigger configured

A post-confirmation AWS Lambda trigger.

Returns:

See Also:



89
90
91
 
# File 'cognito/user_pool_triggers.rb', line 89

def post_confirmation
  @post_confirmation
end

#pre_authentication ⇒ AWSCDK::Lambda::IFunction? (readonly)

Note:

Default: - no trigger configured

A pre-authentication AWS Lambda trigger.

Returns:

See Also:



95
96
97
 
# File 'cognito/user_pool_triggers.rb', line 95

def pre_authentication
  @pre_authentication
end

#pre_sign_up ⇒ AWSCDK::Lambda::IFunction? (readonly)

Note:

Default: - no trigger configured

A pre-registration AWS Lambda trigger.

Returns:

See Also:



101
102
103
 
# File 'cognito/user_pool_triggers.rb', line 101

def 
  @pre_sign_up
end

#pre_token_generation ⇒ AWSCDK::Lambda::IFunction? (readonly)

Note:

Default: - no trigger configured

A pre-token-generation AWS Lambda trigger.

Returns:

See Also:



107
108
109
 
# File 'cognito/user_pool_triggers.rb', line 107

def pre_token_generation
  @pre_token_generation
end

#user_migration ⇒ AWSCDK::Lambda::IFunction? (readonly)

Note:

Default: - no trigger configured

A user-migration AWS Lambda trigger.

Returns:

See Also:



113
114
115
 
# File 'cognito/user_pool_triggers.rb', line 113

def user_migration
  @user_migration
end

#verify_auth_challenge_response ⇒ AWSCDK::Lambda::IFunction? (readonly)

Note:

Default: - no trigger configured

Verifies the authentication challenge response.

Returns:

See Also:



119
120
121
 
# File 'cognito/user_pool_triggers.rb', line 119

def verify_auth_challenge_response
  @verify_auth_challenge_response
end

Class Method Details

.jsii_properties ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'cognito/user_pool_triggers.rb', line 121

def self.jsii_properties
  {
    :create_auth_challenge => "createAuthChallenge",
    :custom_email_sender => "customEmailSender",
    :custom_message => "customMessage",
    :custom_sms_sender => "customSmsSender",
    :define_auth_challenge => "defineAuthChallenge",
    :post_authentication => "postAuthentication",
    :post_confirmation => "postConfirmation",
    :pre_authentication => "preAuthentication",
    :pre_sign_up => "preSignUp",
    :pre_token_generation => "preTokenGeneration",
    :user_migration => "userMigration",
    :verify_auth_challenge_response => "verifyAuthChallengeResponse",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'cognito/user_pool_triggers.rb', line 138

def to_jsii
  result = {}
  result.merge!({
    "createAuthChallenge" => @create_auth_challenge,
    "customEmailSender" => @custom_email_sender,
    "customMessage" => @custom_message,
    "customSmsSender" => @custom_sms_sender,
    "defineAuthChallenge" => @define_auth_challenge,
    "postAuthentication" => @post_authentication,
    "postConfirmation" => @post_confirmation,
    "preAuthentication" => @pre_authentication,
    "preSignUp" => @pre_sign_up,
    "preTokenGeneration" => @pre_token_generation,
    "userMigration" => @user_migration,
    "verifyAuthChallengeResponse" => @verify_auth_challenge_response,
  })
  result.compact
end