Class: Aws::AmplifyBackend::Types::BackendAPIAuthType

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb

Overview

Note:

When making an API call, you may pass BackendAPIAuthType data as a hash:

{
  mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
  settings: {
    cognito_user_pool_id: "__string",
    description: "__string",
    expiration_time: 1.0,
    open_id_auth_ttl: "__string",
    open_id_client_id: "__string",
    open_id_iat_ttl: "__string",
    open_id_issue_url: "__string",
    open_id_provider_name: "__string",
  },
}

Describes the auth types for your configured data models.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#mode ⇒ String

Describes the authentication mode.

Returns:

  • (String) 


112
113
114
115
116
117
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 112

class BackendAPIAuthType < Struct.new(
  :mode,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end

#settings ⇒ Types::BackendAPIAppSyncAuthSettings

Describes settings for the authentication mode.

Returns:



112
113
114
115
116
117
 
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 112

class BackendAPIAuthType < Struct.new(
  :mode,
  :settings)
  SENSITIVE = []
  include Aws::Structure
end