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

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 BackendAPIAppSyncAuthSettings data as a hash:

{
  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",
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cognito_user_pool_idString

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

Returns:

  • (String)


70
71
72
73
74
75
76
77
78
79
80
81
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 70

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

#descriptionString

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

Returns:

  • (String)


70
71
72
73
74
75
76
77
78
79
80
81
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 70

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_timeFloat

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

Returns:

  • (Float)


70
71
72
73
74
75
76
77
78
79
80
81
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 70

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_ttlString

The expiry time for the OpenID authentication mechanism.

Returns:

  • (String)


70
71
72
73
74
75
76
77
78
79
80
81
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 70

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_idString

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

Returns:

  • (String)


70
71
72
73
74
75
76
77
78
79
80
81
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 70

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_ttlString

The expiry time for the OpenID authentication mechanism.

Returns:

  • (String)


70
71
72
73
74
75
76
77
78
79
80
81
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 70

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_urlString

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

Returns:

  • (String)


70
71
72
73
74
75
76
77
78
79
80
81
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 70

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_nameString

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

Returns:

  • (String)


70
71
72
73
74
75
76
77
78
79
80
81
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 70

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