Interface CfnGraphQLApi.UserPoolConfigProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnGraphQLApi.UserPoolConfigProperty.Jsii$Proxy
- Enclosing class:
CfnGraphQLApi
@Stability(Stable)
public static interface CfnGraphQLApi.UserPoolConfigProperty
extends software.amazon.jsii.JsiiSerializable
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.appsync.*; UserPoolConfigProperty userPoolConfigProperty = UserPoolConfigProperty.builder() .appIdClientRegex("appIdClientRegex") .awsRegion("awsRegion") .defaultAction("defaultAction") .userPoolId("userPoolId") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnGraphQLApi.UserPoolConfigProperty
static final class
An implementation forCfnGraphQLApi.UserPoolConfigProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
A regular expression for validating the incoming Amazon Cognito user pool app client ID.default String
The AWS Region in which the user pool was created.default 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.default String
The user pool ID.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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.
- See Also:
-
getAwsRegion
The AWS Region in which the user pool was created.- See Also:
-
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
toALLOW
if specifyingAdditionalAuthenticationProviders
.- See Also:
-
getUserPoolId
The user pool ID.- See Also:
-
builder
-