Class: AWSCDK::Cognito::AuthFlow

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

Overview

Types of authentication flow.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(admin_user_password: nil, custom: nil, user: nil, user_password: nil, user_srp: nil) ⇒ AuthFlow

Returns a new instance of AuthFlow.

Parameters:

  • admin_user_password (Boolean, nil) (defaults to: nil) —

    Enable admin based user password authentication flow.

  • custom (Boolean, nil) (defaults to: nil) —

    Enable custom authentication flow.

  • user (Boolean, nil) (defaults to: nil) —

    Enable Choice-based authentication.

  • user_password (Boolean, nil) (defaults to: nil) —

    Enable auth using username & password.

  • user_srp (Boolean, nil) (defaults to: nil) —

    Enable SRP based authentication.



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'cognito/auth_flow.rb', line 14

def initialize(admin_user_password: nil, custom: nil, user: nil, user_password: nil, user_srp: nil)
  @admin_user_password = admin_user_password
  Jsii::Type.check_type(@admin_user_password, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "adminUserPassword") unless @admin_user_password.nil?
  @custom = custom
  Jsii::Type.check_type(@custom, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "custom") unless @custom.nil?
  @user = user
  Jsii::Type.check_type(@user, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "user") unless @user.nil?
  @user_password = user_password
  Jsii::Type.check_type(@user_password, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "userPassword") unless @user_password.nil?
  @user_srp = user_srp
  Jsii::Type.check_type(@user_srp, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "userSrp") unless @user_srp.nil?
end

Instance Attribute Details

#admin_user_password ⇒ Boolean? (readonly)

Note:

Default: false

Enable admin based user password authentication flow.

Returns:

  • (Boolean, nil) 


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

def admin_user_password
  @admin_user_password
end

#custom ⇒ Boolean? (readonly)

Note:

Default: false

Enable custom authentication flow.

Returns:

  • (Boolean, nil) 


36
37
38
 
# File 'cognito/auth_flow.rb', line 36

def custom
  @custom
end

#user ⇒ Boolean? (readonly)

Note:

Default: false

Enable Choice-based authentication.

Returns:

  • (Boolean, nil) 


41
42
43
 
# File 'cognito/auth_flow.rb', line 41

def user
  @user
end

#user_password ⇒ Boolean? (readonly)

Note:

Default: false

Enable auth using username & password.

Returns:

  • (Boolean, nil) 


46
47
48
 
# File 'cognito/auth_flow.rb', line 46

def user_password
  @user_password
end

#user_srp ⇒ Boolean? (readonly)

Note:

Default: false

Enable SRP based authentication.

Returns:

  • (Boolean, nil) 


51
52
53
 
# File 'cognito/auth_flow.rb', line 51

def user_srp
  @user_srp
end

Class Method Details

.jsii_properties ⇒ Object 



53
54
55
56
57
58
59
60
61
 
# File 'cognito/auth_flow.rb', line 53

def self.jsii_properties
  {
    :admin_user_password => "adminUserPassword",
    :custom => "custom",
    :user => "user",
    :user_password => "userPassword",
    :user_srp => "userSrp",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
 
# File 'cognito/auth_flow.rb', line 63

def to_jsii
  result = {}
  result.merge!({
    "adminUserPassword" => @admin_user_password,
    "custom" => @custom,
    "user" => @user,
    "userPassword" => @user_password,
    "userSrp" => @user_srp,
  })
  result.compact
end