Interface CfnGraphQLApi.UserPoolConfigProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnGraphQLApi.UserPoolConfigProperty extends
The UserPoolConfig property type specifies the optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint for an AWS AppSync GraphQL API.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 UserPoolConfigProperty userPoolConfigProperty = UserPoolConfigProperty.builder()
  • Method Details

    • getAppIdClientRegex

      @Stability(Stable) @Nullable default String getAppIdClientRegex()
      A regular expression for validating the incoming Amazon Cognito user pool app client ID.

      If this value isn't set, no filtering is applied.

    • getAwsRegion

      @Stability(Stable) @Nullable default String getAwsRegion()
      The AWS Region in which the user pool was created.
    • getDefaultAction

      @Stability(Stable) @Nullable default String getDefaultAction()
      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.

      When specifying Amazon Cognito user pools as the default authentication, you must set the value for DefaultAction to ALLOW if specifying AdditionalAuthenticationProviders .

    • getUserPoolId

      @Stability(Stable) @Nullable default String getUserPoolId()
      The user pool ID.
    • builder

      @Stability(Stable) static CfnGraphQLApi.UserPoolConfigProperty.Builder builder()
      a CfnGraphQLApi.UserPoolConfigProperty.Builder of CfnGraphQLApi.UserPoolConfigProperty