Class: AWSCDK::AppSync::AppSyncCognitoConfig

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_sync/app_sync_cognito_config.rb

Overview

Configuration for Cognito user-pools in AppSync for Api.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_pool:, app_id_client_regex: nil) ⇒ AppSyncCognitoConfig

Returns a new instance of AppSyncCognitoConfig.

Parameters:

  • user_pool (AWSCDK::Cognito::IUserPool)

    The Cognito user pool to use as identity source.

  • app_id_client_regex (String, nil) (defaults to: nil)

    the optional app id regex.



9
10
11
12
13
14
# File 'app_sync/app_sync_cognito_config.rb', line 9

def initialize(user_pool:, app_id_client_regex: nil)
  @user_pool = user_pool
  Jsii::Type.check_type(@user_pool, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5JVXNlclBvb2wifQ==")), "userPool")
  @app_id_client_regex = app_id_client_regex
  Jsii::Type.check_type(@app_id_client_regex, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "appIdClientRegex") unless @app_id_client_regex.nil?
end

Instance Attribute Details

#app_id_client_regexString? (readonly)

Note:

Default: - None

the optional app id regex.

Returns:

  • (String, nil)


24
25
26
# File 'app_sync/app_sync_cognito_config.rb', line 24

def app_id_client_regex
  @app_id_client_regex
end

#user_poolAWSCDK::Cognito::IUserPool (readonly)

The Cognito user pool to use as identity source.



19
20
21
# File 'app_sync/app_sync_cognito_config.rb', line 19

def user_pool
  @user_pool
end

Class Method Details

.jsii_propertiesObject



26
27
28
29
30
31
# File 'app_sync/app_sync_cognito_config.rb', line 26

def self.jsii_properties
  {
    :user_pool => "userPool",
    :app_id_client_regex => "appIdClientRegex",
  }
end

Instance Method Details

#to_jsiiObject



33
34
35
36
37
38
39
40
# File 'app_sync/app_sync_cognito_config.rb', line 33

def to_jsii
  result = {}
  result.merge!({
    "userPool" => @user_pool,
    "appIdClientRegex" => @app_id_client_regex,
  })
  result.compact
end