Class CfnGraphQLApi.UserPoolConfigProperty
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.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class UserPoolConfigProperty : Object, CfnGraphQLApi.IUserPoolConfigProperty
Syntax (vb)
Public Class UserPoolConfigProperty
Inherits Object
Implements CfnGraphQLApi.IUserPoolConfigProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// 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"
};
Synopsis
Constructors
UserPoolConfigProperty() |
Properties
AppIdClientRegex | A regular expression for validating the incoming Amazon Cognito user pool app client ID. |
AwsRegion | The AWS Region in which the user pool was created. |
DefaultAction | 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. |
UserPoolId | The user pool ID. |
Constructors
UserPoolConfigProperty()
public UserPoolConfigProperty()
Properties
AppIdClientRegex
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
public string AppIdClientRegex { get; set; }
Property Value
System.String
Remarks
If this value isn't set, no filtering is applied.
AwsRegion
The AWS Region in which the user pool was created.
public string AwsRegion { get; set; }
Property Value
System.String
Remarks
DefaultAction
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.
public string DefaultAction { get; set; }
Property Value
System.String
Remarks
When specifying Amazon Cognito user pools as the default authentication, you must set the value for DefaultAction
to ALLOW
if specifying AdditionalAuthenticationProviders
.
UserPoolId
The user pool ID.
public string UserPoolId { get; set; }
Property Value
System.String