You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

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

{
  user_pool_id: "String", # required
  aws_region: "String", # required
  default_action: "ALLOW", # required, accepts ALLOW, DENY
  app_id_client_regex: "String",
}

Describes an Amazon Cognito User Pool configuration.

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.

Returns:

  • (String)


1765
1766
1767
1768
1769
1770
1771
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1765

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

#aws_regionString

The AWS region in which the user pool was created.

Returns:

  • (String)


1765
1766
1767
1768
1769
1770
1771
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1765

class UserPoolConfig < Struct.new(
  :user_pool_id,
  :aws_region,
  :default_action,
  :app_id_client_regex)
  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)


1765
1766
1767
1768
1769
1770
1771
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1765

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

#user_pool_idString

The user pool ID.

Returns:

  • (String)


1765
1766
1767
1768
1769
1770
1771
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1765

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