Class: AWSCDK::CognitoIdentitypool::UserPoolAuthenticationProviderProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cognito_identitypool/user_pool_authentication_provider_props.rb

Overview

Props for the User Pool Authentication Provider.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_pool:, disable_server_side_token_check: nil, user_pool_client: nil) ⇒ UserPoolAuthenticationProviderProps

Returns a new instance of UserPoolAuthenticationProviderProps.

Parameters:

  • user_pool (AWSCDK::Cognito::IUserPool) —

    The User Pool of the Associated Identity Providers.

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

    Setting this to true turns off identity pool checks for this user pool to make sure the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

  • user_pool_client (AWSCDK::Interfaces::AWSCognito::IUserPoolClientRef, nil) (defaults to: nil) —

    The User Pool Client for the provided User Pool.



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

def initialize(user_pool:, disable_server_side_token_check: nil, user_pool_client: nil)
  @user_pool = user_pool
  Jsii::Type.check_type(@user_pool, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5JVXNlclBvb2wifQ==")), "userPool")
  @disable_server_side_token_check = disable_server_side_token_check
  Jsii::Type.check_type(@disable_server_side_token_check, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "disableServerSideTokenCheck") unless @disable_server_side_token_check.nil?
  @user_pool_client = user_pool_client
  Jsii::Type.check_type(@user_pool_client, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb2duaXRvLklVc2VyUG9vbENsaWVudFJlZiJ9")), "userPoolClient") unless @user_pool_client.nil?
end

Instance Attribute Details

#disable_server_side_token_check ⇒ Boolean? (readonly)

Note:

Default: false

Setting this to true turns off identity pool checks for this user pool to make sure the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

Returns:

  • (Boolean, nil)

See Also:



28
29
30
 
# File 'cognito_identitypool/user_pool_authentication_provider_props.rb', line 28

def disable_server_side_token_check
  @disable_server_side_token_check
end

#user_pool ⇒ AWSCDK::Cognito::IUserPool (readonly)

The User Pool of the Associated Identity Providers.

Returns:



22
23
24
 
# File 'cognito_identitypool/user_pool_authentication_provider_props.rb', line 22

def user_pool
  @user_pool
end

#user_pool_client ⇒ AWSCDK::Interfaces::AWSCognito::IUserPoolClientRef? (readonly)

Note:

Default: - A default user pool client will be added to User Pool

The User Pool Client for the provided User Pool.

Returns:



33
34
35
 
# File 'cognito_identitypool/user_pool_authentication_provider_props.rb', line 33

def user_pool_client
  @user_pool_client
end

Class Method Details

.jsii_properties ⇒ Object 



35
36
37
38
39
40
41
 
# File 'cognito_identitypool/user_pool_authentication_provider_props.rb', line 35

def self.jsii_properties
  {
    :user_pool => "userPool",
    :disable_server_side_token_check => "disableServerSideTokenCheck",
    :user_pool_client => "userPoolClient",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'cognito_identitypool/user_pool_authentication_provider_props.rb', line 43

def to_jsii
  result = {}
  result.merge!({
    "userPool" => @user_pool,
    "disableServerSideTokenCheck" => @disable_server_side_token_check,
    "userPoolClient" => @user_pool_client,
  })
  result.compact
end