Class: Aws::AppSync::Types::UserPoolConfig

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

Overview

Describes an Amazon Cognito user pool configuration.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#app_id_client_regexString

A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn’t set, no filtering is applied.

Returns:

  • (String)


5696
5697
5698
5699
5700
5701
5702
5703
# File 'lib/aws-sdk-appsync/types.rb', line 5696

class UserPoolConfig < Struct.new(
  :user_pool_id,
  :aws_region,
  :default_action,
  :app_id_client_regex)
  SENSITIVE = []
  include Aws::Structure
end

#aws_regionString

The Amazon Web Services Region in which the user pool was created.

Returns:

  • (String)


5696
5697
5698
5699
5700
5701
5702
5703
# File 'lib/aws-sdk-appsync/types.rb', line 5696

class UserPoolConfig < Struct.new(
  :user_pool_id,
  :aws_region,
  :default_action,
  :app_id_client_regex)
  SENSITIVE = []
  include Aws::Structure
end

#default_actionString

The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn’t match the Amazon Cognito user pool configuration.

Returns:

  • (String)


5696
5697
5698
5699
5700
5701
5702
5703
# File 'lib/aws-sdk-appsync/types.rb', line 5696

class UserPoolConfig < Struct.new(
  :user_pool_id,
  :aws_region,
  :default_action,
  :app_id_client_regex)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_idString

The user pool ID.

Returns:

  • (String)


5696
5697
5698
5699
5700
5701
5702
5703
# File 'lib/aws-sdk-appsync/types.rb', line 5696

class UserPoolConfig < Struct.new(
  :user_pool_id,
  :aws_region,
  :default_action,
  :app_id_client_regex)
  SENSITIVE = []
  include Aws::Structure
end