Interface CfnGraphQLApiPropsMixin.IUserPoolConfigProperty

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.

Namespace: Amazon.CDK.Mixins.Preview.AWS.AppSync.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public interface CfnGraphQLApiPropsMixin.IUserPoolConfigProperty

Syntax (vb)

Public Interface CfnGraphQLApiPropsMixin.IUserPoolConfigProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html

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.Mixins.Preview.AWS.AppSync.Mixins;

             var userPoolConfigProperty = new UserPoolConfigProperty {
                 AppIdClientRegex = "appIdClientRegex",
                 AwsRegion = "awsRegion",
                 DefaultAction = "defaultAction",
                 UserPoolId = "userPoolId"
             };

Synopsis

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.

Properties

AppIdClientRegex

A regular expression for validating the incoming Amazon Cognito user pool app client ID.

string? AppIdClientRegex { get; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html#cfn-appsync-graphqlapi-userpoolconfig-appidclientregex

AwsRegion

The AWS Region in which the user pool was created.

string? AwsRegion { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html#cfn-appsync-graphqlapi-userpoolconfig-awsregion

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.

string? DefaultAction { get; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html#cfn-appsync-graphqlapi-userpoolconfig-defaultaction

UserPoolId

The user pool ID.

string? UserPoolId { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html#cfn-appsync-graphqlapi-userpoolconfig-userpoolid