UserPoolConfigProperty Struct
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.
| Source | |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
const userPoolConfigProperty: appsync.CfnGraphQLApi.UserPoolConfigProperty = {
appIdClientRegex: 'appIdClientRegex',
awsRegion: 'awsRegion',
defaultAction: 'defaultAction',
userPoolId: 'userPoolId',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appsync as appsync
user_pool_config_property = appsync.CfnGraphQLApi.UserPoolConfigProperty(
app_id_client_regex="appIdClientRegex",
aws_region="awsRegion",
default_action="defaultAction",
user_pool_id="userPoolId"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppSync;
var userPoolConfigProperty = new UserPoolConfigProperty {
AppIdClientRegex = "appIdClientRegex",
AwsRegion = "awsRegion",
DefaultAction = "defaultAction",
UserPoolId = "userPoolId"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
userPoolConfigProperty := &UserPoolConfigProperty{
AppIdClientRegex: jsii.String("appIdClientRegex"),
AwsRegion: jsii.String("awsRegion"),
DefaultAction: jsii.String("defaultAction"),
UserPoolId: jsii.String("userPoolId"),
}
Properties
appIdClientRegexoptionalstringapp_id_client_regexoptionalstrappIdClientRegexoptionalStringAppIdClientRegexoptionalstringAppIdClientRegexoptional*string #A regular expression for validating the incoming Amazon Cognito user pool app client ID.
If this value isn't set, no filtering is applied.
awsRegionoptionalstringaws_regionoptionalstrawsRegionoptionalStringAwsRegionoptionalstringAwsRegionoptional*string #The AWS Region in which the user pool was created.
defaultActionoptionalstringdefault_actionoptionalstrdefaultActionoptionalStringDefaultActionoptionalstringDefaultActionoptional*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.
When specifying Amazon Cognito user pools as the default authentication, you must set the value for DefaultAction to ALLOW if specifying AdditionalAuthenticationProviders .
userPoolIdoptionalstringuser_pool_idoptionalstruserPoolIdoptionalStringUserPoolIdoptionalstringUserPoolIdoptional*string #The user pool ID.