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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UserPoolConfig as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

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)

    A regular expression for validating the incoming Amazon Cognito User Pool app client ID.

#aws_regionString

The AWS region in which the user pool was created.

Returns:

  • (String)

    The AWS region in which the user pool was created.

#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.

Possible values:

  • ALLOW
  • DENY

Returns:

  • (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.

#user_pool_idString

The user pool ID.

Returns:

  • (String)

    The user pool ID.