Class: Aws::AmplifyBackend::Types::BackendAPIAppSyncAuthSettings

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

Overview

The authentication settings for accessing provisioned data models in your Amplify project.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cognito_user_pool_id ⇒ String

The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

Returns:

  • (String) 


56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/aws-sdk-amplifybackend/types.rb', line 56

class BackendAPIAppSyncAuthSettings < Struct.new(
  :cognito_user_pool_id,
  :description,
  :expiration_time,
  :open_id_auth_ttl,
  :open_id_client_id,
  :open_id_iat_ttl,
  :open_id_issue_url,
  :open_id_provider_name)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

Returns:

  • (String) 


56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/aws-sdk-amplifybackend/types.rb', line 56

class BackendAPIAppSyncAuthSettings < Struct.new(
  :cognito_user_pool_id,
  :description,
  :expiration_time,
  :open_id_auth_ttl,
  :open_id_client_id,
  :open_id_iat_ttl,
  :open_id_issue_url,
  :open_id_provider_name)
  SENSITIVE = []
  include Aws::Structure
end

#expiration_time ⇒ Float

The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

Returns:

  • (Float) 


56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/aws-sdk-amplifybackend/types.rb', line 56

class BackendAPIAppSyncAuthSettings < Struct.new(
  :cognito_user_pool_id,
  :description,
  :expiration_time,
  :open_id_auth_ttl,
  :open_id_client_id,
  :open_id_iat_ttl,
  :open_id_issue_url,
  :open_id_provider_name)
  SENSITIVE = []
  include Aws::Structure
end

#open_id_auth_ttl ⇒ String

The expiry time for the OpenID authentication mechanism.

Returns:

  • (String) 


56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/aws-sdk-amplifybackend/types.rb', line 56

class BackendAPIAppSyncAuthSettings < Struct.new(
  :cognito_user_pool_id,
  :description,
  :expiration_time,
  :open_id_auth_ttl,
  :open_id_client_id,
  :open_id_iat_ttl,
  :open_id_issue_url,
  :open_id_provider_name)
  SENSITIVE = []
  include Aws::Structure
end

#open_id_client_id ⇒ String

The clientID for openID, if openID was used as an authentication setting to access your data models.

Returns:

  • (String) 


56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/aws-sdk-amplifybackend/types.rb', line 56

class BackendAPIAppSyncAuthSettings < Struct.new(
  :cognito_user_pool_id,
  :description,
  :expiration_time,
  :open_id_auth_ttl,
  :open_id_client_id,
  :open_id_iat_ttl,
  :open_id_issue_url,
  :open_id_provider_name)
  SENSITIVE = []
  include Aws::Structure
end

#open_id_iat_ttl ⇒ String

The expiry time for the OpenID authentication mechanism.

Returns:

  • (String) 


56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/aws-sdk-amplifybackend/types.rb', line 56

class BackendAPIAppSyncAuthSettings < Struct.new(
  :cognito_user_pool_id,
  :description,
  :expiration_time,
  :open_id_auth_ttl,
  :open_id_client_id,
  :open_id_iat_ttl,
  :open_id_issue_url,
  :open_id_provider_name)
  SENSITIVE = []
  include Aws::Structure
end

#open_id_issue_url ⇒ String

The openID issuer URL, if openID was used as an authentication setting to access your data models.

Returns:

  • (String) 


56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/aws-sdk-amplifybackend/types.rb', line 56

class BackendAPIAppSyncAuthSettings < Struct.new(
  :cognito_user_pool_id,
  :description,
  :expiration_time,
  :open_id_auth_ttl,
  :open_id_client_id,
  :open_id_iat_ttl,
  :open_id_issue_url,
  :open_id_provider_name)
  SENSITIVE = []
  include Aws::Structure
end

#open_id_provider_name ⇒ String

The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

Returns:

  • (String) 


56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/aws-sdk-amplifybackend/types.rb', line 56

class BackendAPIAppSyncAuthSettings < Struct.new(
  :cognito_user_pool_id,
  :description,
  :expiration_time,
  :open_id_auth_ttl,
  :open_id_client_id,
  :open_id_iat_ttl,
  :open_id_issue_url,
  :open_id_provider_name)
  SENSITIVE = []
  include Aws::Structure
end