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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#app_id_client_regex ⇒ String

A regular expression for validating the incoming Amazon Cognito user pool app client ID.

Returns:

  • (String) 


2796
2797
2798
2799
2800
2801
2802
 
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2796

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

#aws_region ⇒ String

The AWS Region in which the user pool was created.

Returns:

  • (String) 


2796
2797
2798
2799
2800
2801
2802
 
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2796

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

#default_action ⇒ String

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) 


2796
2797
2798
2799
2800
2801
2802
 
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2796

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

#user_pool_id ⇒ String

The user pool ID.

Returns:

  • (String) 


2796
2797
2798
2799
2800
2801
2802
 
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2796

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