Class: AWSCDK::Cognito::SignInURLOptions

Inherits:
BaseURLOptions
  • Object
show all
Defined in:
cognito/sign_in_url_options.rb

Overview

Options to customize the behaviour of signInUrl().

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(fips: nil, redirect_uri:, sign_in_path: nil) ⇒ SignInURLOptions

Returns a new instance of SignInURLOptions.

Parameters:

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

    Whether to return the FIPS-compliant endpoint.

  • redirect_uri (String) —

    Where to redirect to after sign in.

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

    The path in the URI where the sign-in page is located.



10
11
12
13
14
15
16
17
 
# File 'cognito/sign_in_url_options.rb', line 10

def initialize(fips: nil, redirect_uri:, sign_in_path: nil)
  @fips = fips
  Jsii::Type.check_type(@fips, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "fips") unless @fips.nil?
  @redirect_uri = redirect_uri
  Jsii::Type.check_type(@redirect_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "redirectUri")
  @sign_in_path = 
  Jsii::Type.check_type(@sign_in_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "signInPath") unless @sign_in_path.nil?
end

Instance Attribute Details

#fips ⇒ Boolean? (readonly)

Note:

Default: return the standard URL

Whether to return the FIPS-compliant endpoint.

Returns:

  • (Boolean, nil) 


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

def fips
  @fips
end

#redirect_uri ⇒ String (readonly)

Where to redirect to after sign in.

Returns:

  • (String) 


27
28
29
 
# File 'cognito/sign_in_url_options.rb', line 27

def redirect_uri
  @redirect_uri
end

#sign_in_path ⇒ String? (readonly)

Note:

Default: '/login'

The path in the URI where the sign-in page is located.

Returns:

  • (String, nil) 


32
33
34
 
# File 'cognito/sign_in_url_options.rb', line 32

def 
  @sign_in_path
end

Class Method Details

.jsii_properties ⇒ Object 



34
35
36
37
38
39
40
 
# File 'cognito/sign_in_url_options.rb', line 34

def self.jsii_properties
  {
    :fips => "fips",
    :redirect_uri => "redirectUri",
    :sign_in_path => "signInPath",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



42
43
44
45
46
47
48
49
50
51
 
# File 'cognito/sign_in_url_options.rb', line 42

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "fips" => @fips,
    "redirectUri" => @redirect_uri,
    "signInPath" => @sign_in_path,
  })
  result.compact
end