Class: AWSCDK::AppSync::EventAPIAuthConfig

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

Overview

Authorization configuration for the Event API.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(auth_providers: nil, connection_auth_mode_types: nil, default_publish_auth_mode_types: nil, default_subscribe_auth_mode_types: nil) ⇒ EventAPIAuthConfig

Returns a new instance of EventAPIAuthConfig.

Parameters:



11
12
13
14
15
16
17
18
19
20
 
# File 'app_sync/event_api_auth_config.rb', line 11

def initialize(auth_providers: nil, connection_auth_mode_types: nil, default_publish_auth_mode_types: nil, default_subscribe_auth_mode_types: nil)
  @auth_providers = auth_providers.is_a?(Array) ? auth_providers.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::AppSync::AppSyncAuthProvider.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : auth_providers
  Jsii::Type.check_type(@auth_providers, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzeW5jLkFwcFN5bmNBdXRoUHJvdmlkZXIifSwia2luZCI6ImFycmF5In19")), "authProviders") unless @auth_providers.nil?
  @connection_auth_mode_types = connection_auth_mode_types
  Jsii::Type.check_type(@connection_auth_mode_types, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzeW5jLkFwcFN5bmNBdXRob3JpemF0aW9uVHlwZSJ9LCJraW5kIjoiYXJyYXkifX0=")), "connectionAuthModeTypes") unless @connection_auth_mode_types.nil?
  @default_publish_auth_mode_types = default_publish_auth_mode_types
  Jsii::Type.check_type(@default_publish_auth_mode_types, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzeW5jLkFwcFN5bmNBdXRob3JpemF0aW9uVHlwZSJ9LCJraW5kIjoiYXJyYXkifX0=")), "defaultPublishAuthModeTypes") unless @default_publish_auth_mode_types.nil?
  @default_subscribe_auth_mode_types = default_subscribe_auth_mode_types
  Jsii::Type.check_type(@default_subscribe_auth_mode_types, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzeW5jLkFwcFN5bmNBdXRob3JpemF0aW9uVHlwZSJ9LCJraW5kIjoiYXJyYXkifX0=")), "defaultSubscribeAuthModeTypes") unless @default_subscribe_auth_mode_types.nil?
end

Instance Attribute Details

#auth_providers ⇒ Array<AWSCDK::AppSync::AppSyncAuthProvider>? (readonly)

Note:

Default: - API Key authorization

Auth providers for use in connection, publish, and subscribe operations.

Returns:



26
27
28
 
# File 'app_sync/event_api_auth_config.rb', line 26

def auth_providers
  @auth_providers
end

#connection_auth_mode_types ⇒ Array<AWSCDK::AppSync::AppSyncAuthorizationType>? (readonly)

Note:

Default: - API Key authorization

Connection auth modes.

Returns:



31
32
33
 
# File 'app_sync/event_api_auth_config.rb', line 31

def connection_auth_mode_types
  @connection_auth_mode_types
end

#default_publish_auth_mode_types ⇒ Array<AWSCDK::AppSync::AppSyncAuthorizationType>? (readonly)

Note:

Default: - API Key authorization

Default publish auth modes.

Returns:



36
37
38
 
# File 'app_sync/event_api_auth_config.rb', line 36

def default_publish_auth_mode_types
  @default_publish_auth_mode_types
end

#default_subscribe_auth_mode_types ⇒ Array<AWSCDK::AppSync::AppSyncAuthorizationType>? (readonly)

Note:

Default: - API Key authorization

Default subscribe auth modes.

Returns:



41
42
43
 
# File 'app_sync/event_api_auth_config.rb', line 41

def default_subscribe_auth_mode_types
  @default_subscribe_auth_mode_types
end

Class Method Details

.jsii_properties ⇒ Object 



43
44
45
46
47
48
49
50
 
# File 'app_sync/event_api_auth_config.rb', line 43

def self.jsii_properties
  {
    :auth_providers => "authProviders",
    :connection_auth_mode_types => "connectionAuthModeTypes",
    :default_publish_auth_mode_types => "defaultPublishAuthModeTypes",
    :default_subscribe_auth_mode_types => "defaultSubscribeAuthModeTypes",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



52
53
54
55
56
57
58
59
60
61
 
# File 'app_sync/event_api_auth_config.rb', line 52

def to_jsii
  result = {}
  result.merge!({
    "authProviders" => @auth_providers,
    "connectionAuthModeTypes" => @connection_auth_mode_types,
    "defaultPublishAuthModeTypes" => @default_publish_auth_mode_types,
    "defaultSubscribeAuthModeTypes" => @default_subscribe_auth_mode_types,
  })
  result.compact
end