Class: AWSCDK::Cognito::UserPoolOperation

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

Overview

User pool operations to which lambda triggers can be attached.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ UserPoolOperation

Returns a new instance of UserPoolOperation.

Raises:

  • (NoMethodError) 


8
9
10
 
# File 'cognito/user_pool_operation.rb', line 8

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.aws_cognito.UserPoolOperation does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.CREATE_AUTH_CHALLENGE ⇒ AWSCDK::Cognito::UserPoolOperation

Creates a challenge in a custom auth flow.

Returns:

  • (AWSCDK::Cognito::UserPoolOperation)

See Also:



31
32
33
 
# File 'cognito/user_pool_operation.rb', line 31

def self.CREATE_AUTH_CHALLENGE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolOperation", "CREATE_AUTH_CHALLENGE")
end

.CUSTOM_EMAIL_SENDER ⇒ AWSCDK::Cognito::UserPoolOperation

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

Returns:

  • (AWSCDK::Cognito::UserPoolOperation)

See Also:



39
40
41
 
# File 'cognito/user_pool_operation.rb', line 39

def self.CUSTOM_EMAIL_SENDER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolOperation", "CUSTOM_EMAIL_SENDER")
end

.CUSTOM_MESSAGE ⇒ AWSCDK::Cognito::UserPoolOperation

Advanced customization and localization of messages.

Returns:

  • (AWSCDK::Cognito::UserPoolOperation)

See Also:



47
48
49
 
# File 'cognito/user_pool_operation.rb', line 47

def self.CUSTOM_MESSAGE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolOperation", "CUSTOM_MESSAGE")
end

.CUSTOM_SMS_SENDER ⇒ AWSCDK::Cognito::UserPoolOperation

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

Returns:

  • (AWSCDK::Cognito::UserPoolOperation)

See Also:



55
56
57
 
# File 'cognito/user_pool_operation.rb', line 55

def self.CUSTOM_SMS_SENDER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolOperation", "CUSTOM_SMS_SENDER")
end

.DEFINE_AUTH_CHALLENGE ⇒ AWSCDK::Cognito::UserPoolOperation

Determines the next challenge in a custom auth flow.

Returns:

  • (AWSCDK::Cognito::UserPoolOperation)

See Also:



63
64
65
 
# File 'cognito/user_pool_operation.rb', line 63

def self.DEFINE_AUTH_CHALLENGE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolOperation", "DEFINE_AUTH_CHALLENGE")
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
 
# File 'cognito/user_pool_operation.rb', line 12

def self.jsii_overridable_methods
  {
    :operation_name => { kind: :property, name: "operationName", is_optional: false },
  }
end

.of(name) ⇒ AWSCDK::Cognito::UserPoolOperation

A custom user pool operation.

Parameters:

  • name (String)

Returns:

  • (AWSCDK::Cognito::UserPoolOperation) 


22
23
24
25
 
# File 'cognito/user_pool_operation.rb', line 22

def self.of(name)
  Jsii::Type.check_type(name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cognito.UserPoolOperation", "of", [name])
end

.POST_AUTHENTICATION ⇒ AWSCDK::Cognito::UserPoolOperation

Event logging for custom analytics.

Returns:

  • (AWSCDK::Cognito::UserPoolOperation)

See Also:



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

def self.POST_AUTHENTICATION()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolOperation", "POST_AUTHENTICATION")
end

.POST_CONFIRMATION ⇒ AWSCDK::Cognito::UserPoolOperation

Custom welcome messages or event logging for custom analytics.

Returns:

  • (AWSCDK::Cognito::UserPoolOperation)

See Also:



79
80
81
 
# File 'cognito/user_pool_operation.rb', line 79

def self.POST_CONFIRMATION()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolOperation", "POST_CONFIRMATION")
end

.PRE_AUTHENTICATION ⇒ AWSCDK::Cognito::UserPoolOperation

Custom validation to accept or deny the sign-in request.

Returns:

  • (AWSCDK::Cognito::UserPoolOperation)

See Also:



87
88
89
 
# File 'cognito/user_pool_operation.rb', line 87

def self.PRE_AUTHENTICATION()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolOperation", "PRE_AUTHENTICATION")
end

.PRE_SIGN_UP ⇒ AWSCDK::Cognito::UserPoolOperation

Custom validation to accept or deny the sign-up request.

Returns:

  • (AWSCDK::Cognito::UserPoolOperation)

See Also:



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

def self.PRE_SIGN_UP()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolOperation", "PRE_SIGN_UP")
end

.PRE_TOKEN_GENERATION ⇒ AWSCDK::Cognito::UserPoolOperation

Add or remove attributes in Id tokens.

Set this parameter for legacy purposes. If you also set an ARN in PreTokenGenerationConfig, its value must be identical to PreTokenGeneration. For new instances of pre token generation triggers, set the LambdaArn of PreTokenGenerationConfig.

Returns:

  • (AWSCDK::Cognito::UserPoolOperation)

See Also:



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

def self.PRE_TOKEN_GENERATION()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolOperation", "PRE_TOKEN_GENERATION")
end

.PRE_TOKEN_GENERATION_CONFIG ⇒ AWSCDK::Cognito::UserPoolOperation

Add or remove attributes in Id tokens and Access tokens.

Returns:

  • (AWSCDK::Cognito::UserPoolOperation)

See Also:



115
116
117
 
# File 'cognito/user_pool_operation.rb', line 115

def self.PRE_TOKEN_GENERATION_CONFIG()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolOperation", "PRE_TOKEN_GENERATION_CONFIG")
end

.USER_MIGRATION ⇒ AWSCDK::Cognito::UserPoolOperation

Migrate a user from an existing user directory to user pools.

Returns:

  • (AWSCDK::Cognito::UserPoolOperation)

See Also:



123
124
125
 
# File 'cognito/user_pool_operation.rb', line 123

def self.USER_MIGRATION()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolOperation", "USER_MIGRATION")
end

.VERIFY_AUTH_CHALLENGE_RESPONSE ⇒ AWSCDK::Cognito::UserPoolOperation

Determines if a response is correct in a custom auth flow.

Returns:

  • (AWSCDK::Cognito::UserPoolOperation)

See Also:



131
132
133
 
# File 'cognito/user_pool_operation.rb', line 131

def self.VERIFY_AUTH_CHALLENGE_RESPONSE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolOperation", "VERIFY_AUTH_CHALLENGE_RESPONSE")
end

Instance Method Details

#operation_name ⇒ String

The key to use in CfnUserPool.LambdaConfigProperty.

Returns:

  • (String) 


138
139
140
 
# File 'cognito/user_pool_operation.rb', line 138

def operation_name()
  jsii_get_property("operationName")
end